forked from facebook/TestSlide
-
Notifications
You must be signed in to change notification settings - Fork 0
/
matchers.py
594 lines (446 loc) · 17.6 KB
/
matchers.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
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
# Copyright (c) Facebook, Inc. and its affiliates.
#
# This source code is licensed under the MIT license found in the
# LICENSE file in the root directory of this source tree.
import re
from typing import Any as AnyType
from typing import (
Callable,
Container,
Dict,
Iterable,
List,
NoReturn,
Optional,
Sized,
TypeVar,
Union,
)
class AlreadyChainedException(Exception):
pass
class _AlreadyChainedMatcher:
"""
Disallow further chaining of equality of objects.
"""
def __and__(self, other: object) -> NoReturn:
raise AlreadyChainedException("Cannot chain more than two matchers")
def __xor__(self, other: object) -> NoReturn:
raise AlreadyChainedException("Cannot chain more than two matchers")
def __invert__(self) -> NoReturn:
raise AlreadyChainedException("Cannot chain more than two matchers")
def __or__(self, other: object) -> NoReturn:
raise AlreadyChainedException("Cannot chain more than two matchers")
class Matcher:
"""
Allows composition of equality of objects by using bitwise operations.
"""
def __and__(self, other: "Matcher") -> "_AndMatcher":
return _AndMatcher(self, other)
def __xor__(self, other: "Matcher") -> "_XorMatcher":
return _XorMatcher(self, other)
def __invert__(self) -> "_InvMatcher":
return _InvMatcher(self)
def __or__(self, other: "Matcher") -> "_OrMatcher":
return _OrMatcher(self, other)
class _AndMatcher(_AlreadyChainedMatcher):
"""
Equality is true if both "a" and "b" are true.
"""
def __init__(self, a: Matcher, b: Matcher) -> None:
self.a = a
self.b = b
def __eq__(self, other: AnyType) -> bool:
return self.a == other and self.b == other
def __repr__(self) -> str:
return f"{self.a} & {self.b}"
class _XorMatcher(_AlreadyChainedMatcher):
def __init__(self, a: Matcher, b: Matcher) -> None:
self.a = a
self.b = b
def __eq__(self, other: AnyType) -> bool:
return (self.a == other or self.b != other) and (
self.a != other or self.b == other
)
def __repr__(self) -> str:
return f"{self.a} ^ {self.b}"
class _InvMatcher(_AlreadyChainedMatcher):
def __init__(self, matcher: Matcher) -> None:
self.matcher = matcher
def __eq__(self, other: AnyType) -> bool:
return not (self.matcher == other)
def __repr__(self) -> str:
return f"! {self.matcher}"
class _OrMatcher(_AlreadyChainedMatcher):
def __init__(self, a: Matcher, b: Matcher) -> None:
self.a = a
self.b = b
def __eq__(self, other: AnyType) -> bool:
return self.a == other or self.b == other
def __repr__(self) -> str:
return f"{self.a} | {self.b}"
class _RichComparison(Matcher):
def __init__(
self,
klass: type,
lt: Optional[AnyType] = None,
le: Optional[AnyType] = None,
eq: Optional[AnyType] = None,
ne: Optional[AnyType] = None,
ge: Optional[AnyType] = None,
gt: Optional[AnyType] = None,
) -> None:
self.klass = klass
self.lt = lt
self.le = le
self.eq = eq
self.ne = ne
self.ge = ge
self.gt = gt
def __eq__(self, other: AnyType) -> bool:
if not isinstance(other, self.klass):
return False
if self.lt is not None and not (other < self.lt):
return False
if self.le is not None and not (other <= self.le):
return False
if self.eq is not None and not (other == self.eq):
return False
if self.ne is not None and not (other != self.ne):
return False
if self.ge is not None and not (other >= self.ge):
return False
if self.gt is not None and not (other > self.gt):
return False
return True
def __repr__(self) -> str:
return "<{} 0x{:02X}{}{}{}{}{}{}>".format(
type(self).__name__,
id(self),
f" lt={self.lt}" if self.lt is not None else "",
f" le={self.le}" if self.le is not None else "",
f" eq={self.eq}" if self.eq is not None else "",
f" ne={self.ne}" if self.ne is not None else "",
f" ge={self.ge}" if self.ge is not None else "",
f" gt={self.gt}" if self.gt is not None else "",
)
class _FloatComparison(_RichComparison):
"""
Compares true if other number passes all rich comparison cases given.
"""
def __init__(
self,
lt: Optional[Union[float, int]] = None,
le: Optional[Union[float, int]] = None,
eq: Optional[Union[float, int]] = None,
ne: Optional[Union[float, int]] = None,
ge: Optional[Union[float, int]] = None,
gt: Optional[Union[float, int]] = None,
) -> None:
super().__init__(float, lt=lt, le=le, eq=eq, ne=ne, ge=ge, gt=gt)
class _IntComparison(_RichComparison):
"""
Compares true if other number passes all rich comparison cases given.
"""
def __init__(
self,
lt: Optional[Union[float, int]] = None,
le: Optional[Union[float, int]] = None,
eq: Optional[Union[float, int]] = None,
ne: Optional[Union[float, int]] = None,
ge: Optional[Union[float, int]] = None,
gt: Optional[Union[float, int]] = None,
) -> None:
super().__init__(int, lt=lt, le=le, eq=eq, ne=ne, ge=ge, gt=gt)
# Ints
class AnyInt(_IntComparison):
def __init__(self) -> None:
super().__init__()
class NotThisInt(_IntComparison):
def __init__(self, ne: int) -> None:
if not isinstance(ne, int):
raise ValueError(
f"NotThisInt(...) expects an 'int' as argument while '{type(ne).__name__}' was provided"
)
super().__init__(ne=ne)
class IntBetween(_IntComparison):
def __init__(self, lower: int, upper: int) -> None:
if not isinstance(lower, (int, float)) or not isinstance(upper, (int, float)):
raise ValueError(
f"IntBetween(...) expects two numerical values as arguments while '{type(lower).__name__}' and '{type(upper).__name__}' were provided"
)
super().__init__(ge=lower, le=upper)
class IntGreaterThan(_IntComparison):
def __init__(self, gt: int) -> None:
if not isinstance(gt, (int, float)):
raise ValueError(
f"IntGreaterThan(...) expects a numerical value as argument while '{type(gt).__name__}' was provided"
)
super().__init__(gt=gt)
class IntGreaterOrEquals(_IntComparison):
def __init__(self, ge: int) -> None:
if not isinstance(ge, (int, float)):
raise ValueError(
f"IntGreaterOrEquals(...) expects a numerical value as argument while '{type(ge).__name__}' was provided"
)
super().__init__(ge=ge)
class IntLessThan(_IntComparison):
def __init__(self, lt: int) -> None:
if not isinstance(lt, (int, float)):
raise ValueError(
f"IntLessThan(...) expects a numerical value as argument while '{type(lt).__name__}' was provided"
)
super().__init__(lt=lt)
class IntLessOrEquals(_IntComparison):
def __init__(self, le: int) -> None:
if not isinstance(le, (int, float)):
raise ValueError(
f"IntLessOrEquals(...) expects a numerical value as argument while '{type(le).__name__}' was provided"
)
super().__init__(le=le)
# floats
class AnyFloat(_FloatComparison):
def __init__(self) -> None:
super().__init__()
class NotThisFloat(_FloatComparison):
def __init__(self, ne: float) -> None:
if not isinstance(ne, float):
raise ValueError(
f"NotThisFloat(...) expects a 'float' as argument while '{type(ne).__name__}' was provided"
)
super().__init__(ne=ne)
class FloatBetween(_FloatComparison):
def __init__(self, lower: float, upper: float) -> None:
if not isinstance(lower, (int, float)) or not isinstance(upper, (int, float)):
raise ValueError(
f"FloatBetween(...) expects numerical values as arguments while '{type(lower).__name__}' and '{type(upper).__name__}' were provided"
)
super().__init__(ge=lower, le=upper)
class FloatGreaterThan(_FloatComparison):
def __init__(self, gt: float) -> None:
if not isinstance(gt, (int, float)):
raise ValueError(
f"FloatGreaterThan(...) expects a numerical value as argument while '{type(gt).__name__}' was provided"
)
super().__init__(gt=gt)
class FloatGreaterOrEquals(_FloatComparison):
def __init__(self, ge: float) -> None:
if not isinstance(ge, (int, float)):
raise ValueError(
f"FloatGreaterOrEquals(...) expects a numerical value as argument while '{type(ge).__name__}' was provided"
)
super().__init__(ge=ge)
class FloatLessThan(_FloatComparison):
def __init__(self, lt: float) -> None:
if not isinstance(lt, (int, float)):
raise ValueError(
f"FloatLessThan(...) expects a numerical value as argument while '{type(lt).__name__}' was provided"
)
super().__init__(lt=lt)
class FloatLessOrEquals(_FloatComparison):
def __init__(self, le: float) -> None:
if not isinstance(le, (int, float)):
raise ValueError(
f"FloatLessOrEquals(...) expects a numerical value as argument while '{type(le).__name__}' was provided"
)
super().__init__(le=le)
# strings
class AnyStr(_RichComparison):
def __init__(self) -> None:
super().__init__(klass=str)
class RegexMatches(Matcher):
"""
Compares true if other matches given regex.
"""
def __init__(self, pattern: str, flags: int = 0) -> None:
self.pattern = pattern
self.flags = flags
self.prog = re.compile(pattern, flags)
def __eq__(self, other: AnyType) -> bool:
if not isinstance(other, str):
return False
return bool(self.prog.match(other))
def __repr__(self) -> str:
return "<RegexMatches 0x{:02X} pattern={}{}>".format(
id(self),
repr(self.pattern),
f" flags={self.flags}" if self.flags != 0 else "",
)
class StrContaining(Matcher):
def __init__(self, needle: str) -> None:
if not isinstance(needle, str):
raise ValueError(
f"StrContaining(...) expects a 'str' as argument while '{type(needle).__name__}' was provided"
)
self.needle = needle
def __eq__(self, other: AnyType) -> bool:
return isinstance(other, str) and self.needle in other
class StrStartingWith(Matcher):
def __init__(self, needle: str) -> None:
if not isinstance(needle, str):
raise ValueError(
f"StrStartingWith(...) expects a 'str' as argument while '{type(needle).__name__}' was provided"
)
self.needle = needle
def __eq__(self, other: AnyType) -> bool:
return isinstance(other, str) and other.startswith(self.needle)
class StrEndingWith(Matcher):
def __init__(self, needle: str) -> None:
if not isinstance(needle, str):
raise ValueError(
f"StrEndingWith(...) expects a 'str' as argument while '{type(needle).__name__}' was provided"
)
self.needle = needle
def __eq__(self, other: AnyType) -> bool: # type: ignore
return isinstance(other, str) and other.endswith(self.needle)
# lists
class AnyList(_RichComparison):
def __init__(self) -> None:
super().__init__(klass=List)
class ListContaining(_RichComparison):
def __init__(self, needle: AnyType) -> None:
self.needle = needle
super().__init__(klass=List)
def __eq__(self, other: List[AnyType]) -> bool: # type: ignore
return super().__eq__(other) and self.needle in other
def __repr__(self) -> str:
return "<{} 0x{:02X}{}>".format(
type(self).__name__,
id(self),
f" needle={self.needle}" if self.needle is not None else "",
)
class ListContainingAll(_RichComparison):
def __init__(self, subset: List[AnyType]) -> None:
if not isinstance(subset, list):
raise ValueError(
f"ListContainingAll(...) expects a 'list' as argument while '{type(subset).__name__}' was provided"
)
self.subset = subset
super().__init__(klass=List)
def __eq__(self, other: List[AnyType]) -> bool: # type: ignore
return super().__eq__(other) and all(x in other for x in self.subset)
def __repr__(self) -> str:
return "<{} 0x{:02X}{}>".format(
type(self).__name__,
id(self),
f" subset={self.subset}" if self.subset is not None else "",
)
class NotEmptyList(AnyList):
def __eq__(self, other: List[AnyType]) -> bool: # type: ignore
return super().__eq__(other) and bool(other)
class EmptyList(AnyList):
def __eq__(self, other: List[AnyType]): # type: ignore
return super().__eq__(other) and not bool(other)
# dicts
class AnyDict(_RichComparison):
def __init__(self) -> None:
super().__init__(klass=Dict)
class NotEmptyDict(AnyDict):
def __eq__(self, other: Optional[Dict[AnyType, AnyType]]) -> bool: # type: ignore
return super().__eq__(other) and bool(other)
class EmptyDict(AnyDict):
def __eq__(self, other: Optional[Dict[AnyType, AnyType]]) -> bool: # type: ignore
return super().__eq__(other) and not bool(other)
class DictContainingKeys(_RichComparison):
def __init__(self, expected_keys: List[AnyType]) -> None:
if not isinstance(expected_keys, list):
raise ValueError(
f"DictContainingKeys(...) expects a 'list' as argument while '{type(expected_keys).__name__}' was provided"
)
self.expected_keys = expected_keys
super().__init__(klass=Dict)
def __eq__(self, other: Dict[AnyType, AnyType]) -> bool: # type: ignore
try:
return super().__eq__(other) and all(
attr in other for attr in self.expected_keys
)
except KeyError:
return False
class DictSupersetOf(_RichComparison):
def __init__(self, subset: Dict[AnyType, AnyType]) -> None:
if not isinstance(subset, dict):
raise ValueError(
f"DictSupersetOf(...) expects a 'dict' as argument while '{type(subset).__name__}' was provided"
)
self.subset = subset
super().__init__(klass=Dict)
def __eq__(self, other: Dict[AnyType, AnyType]) -> bool: # type: ignore
try:
return super().__eq__(other) and all(
other[attr] == self.subset[attr] for attr in self.subset.keys()
)
except KeyError:
return False
# generic containers/iterables
class AnyContaining(Matcher):
def __init__(self, needle: AnyType) -> None:
self.needle = needle
def __eq__(self, other: Container[AnyType]) -> bool: # type: ignore
return self.needle in other
def __repr__(self) -> str:
return "<{} 0x{:02X}{}>".format(
type(self).__name__,
id(self),
f" needle={self.needle}" if self.needle is not None else "",
)
class AnyContainingAll(Matcher):
def __init__(self, subset: Iterable[AnyType]) -> None:
self.subset_repr = repr(subset) if subset is not None else ""
self.subset = list(subset)
def __eq__(self, other: Container[AnyType]) -> bool: # type: ignore
return all(x in other for x in self.subset)
def __repr__(self) -> str:
return "<{} 0x{:02X}{}>".format(
type(self).__name__,
id(self),
f" subset={self.subset_repr}",
)
class AnyIterable(Matcher):
def __eq__(self, other: AnyType):
try:
iter(other)
except TypeError:
return False
return True
class IterableWithElements(Matcher):
def __init__(self, elements: Iterable[AnyType]) -> None:
self.elements_repr = repr(elements) if elements is not None else ""
self.elements = list(elements)
def __eq__(self, other: Iterable[AnyType]) -> bool: # type: ignore
return self.elements == list(other)
def __repr__(self) -> str:
return "<{} 0x{:02X}{}>".format(
type(self).__name__,
id(self),
f" elements={self.elements_repr}",
)
class AnyNotEmpty(Matcher):
def __eq__(self, other: Sized) -> bool: # type: ignore
return bool(len(other))
class AnyEmpty(Matcher):
def __eq__(self, other: Sized) -> bool: # type: ignore
return not bool(len(other))
# generic
class Any(Matcher):
def __eq__(self, other: AnyType) -> bool: # type: ignore
return True
class AnyTruthy(Matcher):
def __eq__(self, other: AnyType) -> bool: # type: ignore
return bool(other)
class AnyFalsey(Matcher):
def __eq__(self, other: AnyType) -> bool: # type: ignore
return not bool(other)
class AnyInstanceOf(_RichComparison):
def __init__(self, klass: type) -> None:
if not isinstance(klass, type):
raise ValueError(
"AnyInstanceOf(...) expects a type while a '{}' ('{}') was provided".format(
type(klass).__name__, klass
)
)
super().__init__(klass=klass)
T = TypeVar("T")
class AnyWithCall(Matcher):
def __init__(self, call: Callable[[T], bool]) -> None:
self.call = call
def __eq__(self, other: T) -> bool:
return self.call(other)