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
|
import unittest
from typing import Optional, TypeVar, Union
from overrides import EnforceOverrides, final, override
from overrides.signature import ensure_signature_is_compatible
class Enforcing(EnforceOverrides):
classVariableIsOk = "OK?"
@final
def finality(self):
return "final"
@final
def __and__(self, other):
return True
def nonfinal1(self, param: int) -> str:
return "super1"
def nonfinal2(self):
return "super2"
@property
def nonfinal_property(self):
return "super_property"
@staticmethod
def nonfinal_staticmethod():
return "super_staticmethod"
@classmethod
def nonfinal_classmethod(cls):
return "super_classmethod"
class EnforceTests(unittest.TestCase):
def test_enforcing_when_all_ok(self):
class Subclazz(Enforcing):
classVariableIsOk = "OK!"
@override
def nonfinal1(self, param: int) -> str:
return "2"
sc = Subclazz()
self.assertEqual(sc.finality(), "final")
self.assertEqual(sc.nonfinal1(1), "2")
self.assertEqual(sc.nonfinal2(), "super2")
self.assertEqual(sc.classVariableIsOk, "OK!")
def test_enforcing_when_finality_broken(self):
with self.assertRaises(TypeError):
class BrokesFinality(Enforcing):
def finality(self):
return "NEVER HERE"
def test_trying_to_override_final_magic_method(self):
with self.assertRaises(TypeError):
class FinalMagicOverrides(Enforcing):
def __and__(self, other):
return False
def test_enforcing_when_none_explicit_override(self):
with self.assertRaises(TypeError):
class Overrider(Enforcing):
def nonfinal2(self):
return "NEVER HERE EITHER"
def test_enforcing_when_property_overriden(self):
class PropertyOverrider(Enforcing):
@property
@override
def nonfinal_property(self):
return "subclass_property"
self.assertNotEqual(
PropertyOverrider.nonfinal_property, Enforcing.nonfinal_property
)
def test_enforcing_when_incompatible(self):
with self.assertRaises(TypeError):
class Incompatible(Enforcing):
@override
def nonfinal1(self, param: str):
pass
def test_enforcing_when_staticmethod_overriden(self):
class StaticMethodOverrider(Enforcing):
@staticmethod
@override
def nonfinal_staticmethod():
return "subclass_staticmethod"
self.assertNotEqual(
StaticMethodOverrider.nonfinal_staticmethod(),
Enforcing.nonfinal_staticmethod(),
)
def test_enforcing_when_classmethod_overriden(self):
class ClassMethodOverrider(Enforcing):
@classmethod
@override
def nonfinal_classmethod(cls):
return "subclass_classmethod"
self.assertNotEqual(
ClassMethodOverrider.nonfinal_classmethod(),
Enforcing.nonfinal_classmethod(),
)
def test_enforcing_when_metaclass_method_overridden(self):
class MetaClassMethodOverrider(Enforcing):
def register(self):
pass
with self.assertRaises(TypeError):
class SubClass(MetaClassMethodOverrider):
def register(self):
pass
def test_ensure_compatible_when_compatible(self):
def sup(self, a, /, b: str, c: int, *, d, e, **kwargs) -> object:
pass
def sub(
self, a, b: object, c, d, f: str = "foo", *args, g: str = "bar", e, **kwargs
) -> str:
pass
ensure_signature_is_compatible(sup, sub)
def test_ensure_compatible_when_type_hints_are_strings(self):
def sup(self, x: "str") -> "object":
pass
def sub(self, x: "object") -> "str":
pass
ensure_signature_is_compatible(sup, sub)
def test_ensure_compatible_when_return_types_are_incompatible(self):
def sup(self, x) -> int:
pass
def sub(self, x) -> str:
pass
with self.assertRaises(TypeError):
ensure_signature_is_compatible(sup, sub)
def test_ensure_compatible_when_parameter_positions_are_incompatible(self):
def sup(self, x, y):
pass
def sub(self, y, x):
pass
def sub2(self, z, x):
pass
def sub3(self, y, z):
pass
with self.assertRaises(TypeError):
ensure_signature_is_compatible(sup, sub)
with self.assertRaises(TypeError):
ensure_signature_is_compatible(sup, sub2)
with self.assertRaises(TypeError):
ensure_signature_is_compatible(sup, sub3)
def test_ensure_compatible_when_parameter_types_are_incompatible(self):
def sup(self, x: object):
pass
def sub(self, y: str):
pass
with self.assertRaises(TypeError):
ensure_signature_is_compatible(sup, sub)
def test_ensure_compatible_when_parameter_kinds_are_incompatible(self):
def sup(self, x):
pass
def sub(self, *, x):
pass
with self.assertRaises(TypeError):
ensure_signature_is_compatible(sup, sub)
def test_ensure_compatible_when_parameter_lists_are_incompatible(self):
def sup(self, x):
pass
def sub(self, x, y):
pass
with self.assertRaises(TypeError):
ensure_signature_is_compatible(sup, sub)
def test_ensure_compatible_when_missing_arg(self):
def sup(self):
pass
def sub(self, x):
pass
with self.assertRaises(TypeError):
ensure_signature_is_compatible(sup, sub)
def test_ensure_compatible_when_additional_arg(self):
def sup(self, x):
pass
def sub(self):
pass
with self.assertRaises(TypeError):
ensure_signature_is_compatible(sup, sub)
def test_union_compatible(self):
def sup(self, x: int):
pass
def sub(self, x: Union[int, str]):
pass
ensure_signature_is_compatible(sup, sub)
with self.assertRaises(TypeError):
ensure_signature_is_compatible(sub, sup)
def test_generic_sub(self):
def better_typed_method(self, x: int, y: Optional[str], z: float = 3.0):
pass
def generic_method(self, *args, **kwargs):
pass
ensure_signature_is_compatible(better_typed_method, generic_method)
with self.assertRaises(TypeError):
ensure_signature_is_compatible(generic_method, better_typed_method)
def test_if_super_has_args_then_sub_must_have(self):
def sub1(self, x=2, y=3, z=4, /):
pass
def subbest(self, x=1, /, *burgs):
pass
def supah(self, *args):
pass
# supah() => subbest()
# supah(2) => subbest(2)
# supah(2,3) => subbest(2,3)
# supah(*args) => subbest(*args)
ensure_signature_is_compatible(supah, subbest)
# sub1(1,2,3) => subbest(1,2,3)
# sub1() => subbest()
ensure_signature_is_compatible(sub1, subbest)
with self.assertRaises(TypeError):
# supah() => sub1() ok
# supah(2) => sub1(2) ok
# supah(1,2,3,4) => sub1() takes from 0 to 3 positional arguments but 4 were given
ensure_signature_is_compatible(supah, sub1)
with self.assertRaises(TypeError):
# subbest() => sub1() ok
# subbest(1,2,3) => sub1(1,2,3) ok
# subbest(1,2,3,4) => sub1() takes from 0 to 3 positional arguments but 4 were given
ensure_signature_is_compatible(subbest, sub1)
def test_if_super_has_kwargs_then_sub_must_have(self):
def sub1(self, *, x=3, y=3, z=4):
pass
def sus(self, *, x=3, **kwargs):
pass
def superb(self, **kwargs):
pass
# superb() => sus()
# superb(foo=1) => sus(foo=1)
# superb(x=4) => sus(x=4)
# superb(x=4, foo=1) => sus(x=4, foo=1)
# superb(**kwargs) => sus(**kwargs)
ensure_signature_is_compatible(superb, sus)
ensure_signature_is_compatible(sub1, sus)
with self.assertRaises(TypeError):
ensure_signature_is_compatible(superb, sub1)
with self.assertRaises(TypeError):
ensure_signature_is_compatible(sus, sub1)
def test_allowed_extra_args_in_overrider(self):
def superb(self):
pass
def optional_arg(self, arg=1):
pass
def optional_positional_arg(self, arg2=2, /):
pass
def optional_kw_only_arg(self, *, arg3=3):
pass
# superb() => optional_arg()
ensure_signature_is_compatible(superb, optional_arg)
# superb() => optional_positional_arg()
ensure_signature_is_compatible(superb, optional_positional_arg)
# superb() => optional_kw_only_arg()
ensure_signature_is_compatible(superb, optional_kw_only_arg)
def test_signatures_when_self_mismach(self):
class A:
def foo(self, x: int):
pass
class B:
def bar(me, x: int):
pass
class C:
def zoo(self, x: str):
pass
ensure_signature_is_compatible(A().foo, B().bar)
with self.assertRaises(TypeError):
ensure_signature_is_compatible(A().foo, C().zoo)
ensure_signature_is_compatible(A.foo, B().bar)
with self.assertRaises(TypeError):
ensure_signature_is_compatible(A.foo, C().zoo)
ensure_signature_is_compatible(A.foo, B.bar)
with self.assertRaises(TypeError):
ensure_signature_is_compatible(A.foo, C.zoo)
ensure_signature_is_compatible(A().foo, B.bar)
with self.assertRaises(TypeError):
ensure_signature_is_compatible(A().foo, C.zoo)
def test_signature_with_static_method(self):
class A:
@staticmethod
def foo(x: int):
pass
class B:
@staticmethod
def bar(x: int):
pass
class C:
@staticmethod
def zoo(x: str):
pass
ensure_signature_is_compatible(A().foo, B().bar, True)
with self.assertRaises(TypeError):
ensure_signature_is_compatible(A().foo, C().zoo, True)
ensure_signature_is_compatible(A.foo, B().bar, True)
with self.assertRaises(TypeError):
ensure_signature_is_compatible(A.foo, C().zoo, True)
ensure_signature_is_compatible(A.foo, B.bar, True)
with self.assertRaises(TypeError):
ensure_signature_is_compatible(A.foo, C.zoo, True)
ensure_signature_is_compatible(A().foo, B.bar, True)
with self.assertRaises(TypeError):
ensure_signature_is_compatible(A().foo, C.zoo, True)
def test_typevar_in_signature(self):
T = TypeVar("T")
K = TypeVar("K")
def typevarred(t: T) -> K:
pass
def typed(t: str) -> int:
pass
def untyped(t):
pass
def return_typed(t) -> int:
pass
ensure_signature_is_compatible(typevarred, untyped, True)
ensure_signature_is_compatible(typevarred, typed, True)
ensure_signature_is_compatible(untyped, typevarred, True)
ensure_signature_is_compatible(typed, typevarred, True)
ensure_signature_is_compatible(untyped, return_typed, True)
with self.assertRaises(TypeError):
ensure_signature_is_compatible(untyped, typed, True)
with self.assertRaises(TypeError):
ensure_signature_is_compatible(typed, untyped, True)
def test_nested_typevar_in_signature(self):
T = TypeVar("T")
K = TypeVar("K")
def typevarred(t: Optional[T]) -> Optional[K]:
pass
def typed(t: Optional[str]) -> Optional[int]:
pass
def untyped(t):
pass
def return_typed(t) -> Optional[int]:
pass
ensure_signature_is_compatible(typevarred, untyped, True)
ensure_signature_is_compatible(typevarred, typed, True)
ensure_signature_is_compatible(untyped, typevarred, True)
ensure_signature_is_compatible(typed, typevarred, True)
ensure_signature_is_compatible(untyped, return_typed, True)
|
