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
|
# ==================================================================================================================== #
# _____ _ _ ____ _ #
# _ __ _ |_ _|__ ___ | (_)_ __ __ _ | _ \ ___ ___ ___ _ __ __ _| |_ ___ _ __ ___ #
# | '_ \| | | || |/ _ \ / _ \| | | '_ \ / _` | | | | |/ _ \/ __/ _ \| '__/ _` | __/ _ \| '__/ __| #
# | |_) | |_| || | (_) | (_) | | | | | | (_| |_| |_| | __/ (_| (_) | | | (_| | || (_) | | \__ \ #
# | .__/ \__, ||_|\___/ \___/|_|_|_| |_|\__, (_)____/ \___|\___\___/|_| \__,_|\__\___/|_| |___/ #
# |_| |___/ |___/ #
# ==================================================================================================================== #
# Authors: #
# Patrick Lehmann #
# #
# License: #
# ==================================================================================================================== #
# Copyright 2017-2026 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 Decorators."""
from unittest import TestCase
from pytest import mark
from pyTooling.Decorators import export, InheritDocString, readonly
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)
__all__ = []
@export
class ExportedClass:
pass
class NotYetExportedClass:
pass
class NotExportedClass:
pass
@export
def ExportedFunction():
pass
def NotYetExportedFunction():
pass
def NotExportedFunction():
pass
L = lambda x: x
class Export(TestCase):
def test_ExportedClass(self) -> None:
self.assertIn(ExportedClass.__name__, __all__)
self.assertNotIn(NotExportedClass.__name__, __all__)
def test_ExportedFunction(self) -> None:
self.assertIn(ExportedFunction.__name__, __all__)
self.assertNotIn(NotExportedFunction.__name__, __all__)
def test_ExportTopLevelClass(self) -> None:
export(NotYetExportedClass)
def test_ExportTopLevelFunction(self) -> None:
export(NotYetExportedFunction)
def test_ExportTopLevelLambda(self) -> None:
with self.assertRaises(TypeError):
export(L)
def test_ExportLocalFunction(self) -> None:
with self.assertRaises(TypeError):
@export
def F():
pass
def test_ExportLocalClass(self) -> None:
with self.assertRaises(TypeError):
@export
class C:
pass
class ReadOnly(TestCase):
def test_ReadOnly(self) -> None:
class Data:
_data: int
def __init__(self, data: int) -> None:
self._data = data
@readonly
def length(self) -> int:
return 2 ** self._data
d = Data(2)
self.assertEqual(4, d.length)
with self.assertRaises(AttributeError):
d.length = 5
with self.assertRaises(AttributeError):
del d.length
# FIXME: needs to be activated and tested
@mark.skip("EXPECTED ERROR IS NOT RAISED")
def test_Setter(self) -> None:
with self.assertRaises(AttributeError):
class Data:
_data: int
def __init__(self, data: int) -> None:
self._data = data
@readonly
def length(self) -> int:
return 2 ** self._data
@length.setter
def length(self, value):
self._data = value
d = Data(6)
d.length = 16
# FIXME: needs to be activated and tested
@mark.skip("EXPECTED ERROR IS NOT RAISED")
def test_Deleter(self) -> None:
with self.assertRaises(AttributeError):
class Data:
_data: int
def __init__(self, data: int) -> None:
self._data = data
@readonly
def length(self) -> int:
return 2 ** self._data
@length.deleter
def length(self, value):
del self._data
d = Data(7)
del d.length
class InheritDocStrings(TestCase):
def test_Class_Copy(self) -> None:
class Class1:
"""Class1"""
@InheritDocString(Class1)
class Class2(Class1):
pass
self.assertEqual("Class1", Class1.__doc__)
self.assertEqual(Class1.__doc__, Class2.__doc__)
def test_Class_Override(self) -> None:
class Class1:
"""Class1"""
@InheritDocString(Class1)
class Class2(Class1):
"""Class2"""
self.assertEqual("Class1", Class2.__doc__)
def test_Class_Fallback(self) -> None:
class Class1:
pass
@InheritDocString(Class1, merge=True)
class Class2(Class1):
"""Class2"""
self.assertIsNone(Class1.__doc__)
self.assertEqual("Class2", Class2.__doc__)
def test_Class_Merge(self) -> None:
class Class1:
"""Class1"""
@InheritDocString(Class1, merge=True)
class Class2(Class1):
"""Class2"""
self.assertEqual("Class1", Class1.__doc__)
self.assertEqual("Class1\n\nClass2", Class2.__doc__)
def test_Method(self) -> None:
class Class1:
def method(self):
"""Method's doc-string."""
class Class2(Class1):
@InheritDocString(Class1)
def method(self):
pass
self.assertEqual(Class1.method.__doc__, Class2.method.__doc__)
|
