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
|
import sys
import unittest
from contextlib import contextmanager
from typing import Generic, TypeVar
import test_somepackage
from overrides import override
TObject = TypeVar("TObject", bound="Foo")
@contextmanager
def no_error():
yield
class SubClassOfGeneric(Generic[TObject]):
def some_method(self):
"""Generic sub class."""
pass
class SubSubClassOfGeneric(SubClassOfGeneric["SubSubClassOfGeneric"]):
@override
def some_method(self):
return 17
class SuperClass(object):
@staticmethod
def this_is_static(x, y, z):
pass
def some_method(self):
"""Super Class Docs"""
return "super"
class SomeClass:
"""Super Inner Class Docs"""
def check(self):
return 0
class SubClass(SuperClass):
@override
def some_method(self):
return "sub"
class Subber(SuperClass):
@override
def some_method(self):
"""Subber"""
return 1
class Nest:
class First:
class Second:
def foo(self):
pass
class Sub2(test_somepackage.SomeClass, SuperClass):
@override
def somewhat_fun_method(self):
return "foo"
@override
def some_method(self):
pass
class SubclassOfInt(int):
@override
def __str__(self):
return "subclass of int"
class CheckAtRuntime(SuperClass):
@override(check_at_runtime=True)
def some_method(self, x):
pass
class StaticMethodOverridePass(SuperClass):
@staticmethod
@override
def this_is_static(x, y, z, *args):
pass
class InnerClassOverride(SuperClass):
@override
class SomeClass:
def check(self):
return 1
class ChildOfNested(Nest.First.Second):
@override
def foo(self):
pass
class OverridesTests(unittest.TestCase):
def test_overrides_passes_for_same_package_superclass(self):
sub = SubClass()
self.assertEqual(sub.some_method(), "sub")
self.assertEqual(sub.some_method.__doc__, "Super Class Docs")
def test_override_inner_class(self):
sup = SuperClass.SomeClass()
sub = InnerClassOverride.SomeClass()
self.assertEqual(sup.check(), 0)
self.assertEqual(sub.check(), 1)
self.assertEqual(sup.__doc__, sub.__doc__)
def test_overrides_does_not_override_method_doc(self):
sub = Subber()
self.assertEqual(sub.some_method(), 1)
self.assertEqual(sub.some_method.__doc__, "Subber")
def test_overrides_passes_for_superclass_in_another_package(self):
sub2 = Sub2()
self.assertEqual(sub2.somewhat_fun_method(), "foo")
self.assertEqual(sub2.somewhat_fun_method.__doc__, "LULZ")
def test_assertion_error_is_thrown_when_method_not_in_superclass(self):
try:
class ShouldFail(SuperClass):
@override
def somo_method(self):
pass
raise RuntimeError("Should not go here")
except TypeError:
pass
def test_static_method(self):
try:
class StaticMethodOverrideFail(SuperClass):
@staticmethod
@override
def this_is_static(k, y, z):
pass
raise RuntimeError("Should not go here")
except TypeError:
pass
def test_can_override_builtin(self):
x = SubclassOfInt(10)
self.assertEqual(str(x), "subclass of int")
def test_overrides_method_from_generic_subclass(self):
genericsub = SubSubClassOfGeneric()
self.assertEqual(genericsub.some_method(), 17)
self.assertEqual(genericsub.some_method.__doc__, "Generic sub class.")
def test_overrides_check_at_runtime(self):
with self.assertRaises(TypeError):
CheckAtRuntime().some_method(1)
def test_overrides_builtin_method_correct_signature(self):
class SubclassOfInt(int):
@override
def bit_length(self):
return super().bit_length()
x = SubclassOfInt(1)
self.assertEqual(x.bit_length(), 1)
def test_overrides_builtin_method_incorrect_signature(self):
if sys.version_info >= (3, 7):
expected_error = self.assertRaises(TypeError)
else:
# In 3.6 inspecting signature's isn't possible for builtin
# methods so this this passes the signature check.
expected_error = no_error()
with expected_error:
class SubclassOfInt(int):
@override
def bit_length(self, _):
"This will fail, bit_length takes in no arguments"
if __name__ == "__main__":
unittest.main()
|
