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
|
# ==================================================================================================================== #
# _____ _ _ __ __ _ ____ _ #
# _ __ _ |_ _|__ ___ | (_)_ __ __ _ | \/ | ___| |_ __ _ / ___| | __ _ ___ ___ ___ ___ #
# | '_ \| | | || |/ _ \ / _ \| | | '_ \ / _` | | |\/| |/ _ \ __/ _` | | | |/ _` / __/ __|/ _ \/ __| #
# | |_) | |_| || | (_) | (_) | | | | | | (_| |_| | | | __/ || (_| | |___| | (_| \__ \__ \ __/\__ \ #
# | .__/ \__, ||_|\___/ \___/|_|_|_| |_|\__, (_)_| |_|\___|\__\__,_|\____|_|\__,_|___/___/\___||___/ #
# |_| |___/ |___/ #
# ==================================================================================================================== #
# Authors: #
# Patrick Lehmann #
# #
# License: #
# ==================================================================================================================== #
# Copyright 2017-2025 Patrick Lehmann - Bötzingen, Germany #
# #
# Licensed under the Apache License, Version 2.0 (the "License"); #
# you may not use this file except in compliance with the License. #
# You may obtain a copy of the License at #
# #
# http://www.apache.org/licenses/LICENSE-2.0 #
# #
# Unless required by applicable law or agreed to in writing, software #
# distributed under the License is distributed on an "AS IS" BASIS, #
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. #
# See the License for the specific language governing permissions and #
# limitations under the License. #
# #
# SPDX-License-Identifier: Apache-2.0 #
# ==================================================================================================================== #
#
"""
Unit tests for class :class:`pyTooling.MetaClasses.ExtendedType`.
This test suite tests decorators:
* :func:`@abstractmethod <pyTooling.MetaClasses.abstractmethod>`
* :func:`@mustoverride <pyTooling.MetaClasses.mustoverride>`
"""
from unittest import TestCase
from pyTooling.Decorators import notimplemented
from pyTooling.MetaClasses import ExtendedType, abstractmethod, mustoverride, AbstractClassError
if __name__ == "__main__": # pragma: no cover
print("ERROR: you called a testcase declaration file as an executable module.")
print("Use: 'python -m unittest <testcase module>'")
exit(1)
class AbstractMethod(TestCase):
def test_AbstractBase(self) -> None:
class AbstractBase(metaclass=ExtendedType):
_data: int
def __init__(self, data: int) -> None:
self._data = data
@abstractmethod
def AbstractMethod(self) -> bool:
return False
with self.assertRaises(AbstractClassError) as ExceptionCapture:
AbstractBase(1)
self.assertIn("AbstractBase", str(ExceptionCapture.exception))
self.assertIn("AbstractMethod", str(ExceptionCapture.exception))
def test_AbstractClass(self) -> None:
class AbstractBase(metaclass=ExtendedType):
_data: int
def __init__(self, data: int) -> None:
self._data = data
@abstractmethod
def AbstractMethod(self) -> bool:
return False
class AbstractClass(AbstractBase):
pass
with self.assertRaises(AbstractClassError) as ExceptionCapture:
AbstractClass(2)
self.assertIn("AbstractClass", str(ExceptionCapture.exception))
self.assertIn("AbstractMethod", str(ExceptionCapture.exception))
def test_DerivedAbstractBase(self) -> None:
class AbstractBase(metaclass=ExtendedType):
_data: int
def __init__(self, data: int) -> None:
self._data = data
@abstractmethod
def AbstractMethod(self) -> bool:
return False
class DerivedAbstractBase(AbstractBase):
def AbstractMethod(self) -> bool:
return super().AbstractMethod()
derived = DerivedAbstractBase(3)
with self.assertRaises(NotImplementedError) as ExceptionCapture:
derived.AbstractMethod()
self.assertEqual("Method 'AbstractMethod' is abstract and needs to be overridden in a derived class.", str(ExceptionCapture.exception))
def test_DoubleDerivedAbstractBase(self) -> None:
class AbstractBase(metaclass=ExtendedType):
_data: int
def __init__(self, data: int) -> None:
self._data = data
@abstractmethod
def AbstractMethod(self) -> bool:
return False
class DerivedAbstractBase(AbstractBase):
def AbstractMethod(self) -> bool:
return super().AbstractMethod()
class DoubleDerivedAbstractBase(DerivedAbstractBase):
pass
derived = DoubleDerivedAbstractBase(4)
with self.assertRaises(NotImplementedError) as ExceptionCapture:
derived.AbstractMethod()
self.assertEqual("Method 'AbstractMethod' is abstract and needs to be overridden in a derived class.", str(ExceptionCapture.exception))
def test_DerivedAbstractClass(self) -> None:
class AbstractBase(metaclass=ExtendedType):
_data: int
def __init__(self, data: int) -> None:
self._data = data
@abstractmethod
def AbstractMethod(self) -> bool:
return False
class AbstractClass(AbstractBase):
pass
class DerivedAbstractClass(AbstractClass):
def AbstractMethod(self) -> bool:
return super().AbstractMethod()
derived = DerivedAbstractClass(5)
with self.assertRaises(NotImplementedError) as ExceptionCapture:
derived.AbstractMethod()
self.assertEqual("Method 'AbstractMethod' is abstract and needs to be overridden in a derived class.", str(ExceptionCapture.exception))
def test_MultipleInheritance(self) -> None:
class AbstractBase(metaclass=ExtendedType):
_data: int
def __init__(self, data: int) -> None:
self._data = data
@abstractmethod
def AbstractMethod(self) -> bool:
return False
class Mixin:
def AbstractMethod(self) -> bool:
return True
class MultipleInheritance(AbstractBase, Mixin):
pass
derived = MultipleInheritance(6)
derived.AbstractMethod()
class MustOverride(TestCase):
def test_MustOverrideBase(self) -> None:
class MustOverrideBase(metaclass=ExtendedType):
@mustoverride
def MustOverrideMethod(self) -> bool:
return False
with self.assertRaises(AbstractClassError) as ExceptionCapture:
MustOverrideBase()
self.assertIn("MustOverrideBase", str(ExceptionCapture.exception))
self.assertIn("MustOverrideMethod", str(ExceptionCapture.exception))
def test_MustOverrideClass(self) -> None:
class MustOverrideBase(metaclass=ExtendedType):
@mustoverride
def MustOverrideMethod(self) -> bool:
return False
class MustOverrideClass(MustOverrideBase):
pass
with self.assertRaises(AbstractClassError) as ExceptionCapture:
MustOverrideClass()
self.assertIn("MustOverrideClass", str(ExceptionCapture.exception))
self.assertIn("MustOverrideMethod", str(ExceptionCapture.exception))
def test_DerivedMustOverride(self) -> None:
class MustOverrideBase(metaclass=ExtendedType):
@mustoverride
def MustOverrideMethod(self) -> bool:
return False
class DerivedMustOverrideClass(MustOverrideBase):
def MustOverrideMethod(self) -> bool:
return super().MustOverrideMethod()
DerivedMustOverrideClass()
class NotImplemented(TestCase):
def test_NotImplementedBase(self) -> None:
class NotImplementedBase(metaclass=ExtendedType):
@notimplemented("It's not working.")
def NotYetFinished(self, param: int) -> bool:
"""Documentation is unfinished."""
return False
c = NotImplementedBase()
self.assertEqual("Documentation is unfinished.", c.NotYetFinished.__doc__)
self.assertEqual("NotYetFinished", c.NotYetFinished.__name__)
with self.assertRaises(NotImplementedError) as ExceptionCapture:
c.NotYetFinished(4)
self.assertEqual("It's not working.", str(ExceptionCapture.exception))
|
