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
|
# ==================================================================================================================== #
# _____ _ _ _____ _ _ _ _ ___ #
# _ __ _ |_ _|__ ___ | (_)_ __ __ _|_ _|__ _ __ _ __ ___ (_)_ __ __ _| | | | |_ _| #
# | '_ \| | | || |/ _ \ / _ \| | | '_ \ / _` | | |/ _ \ '__| '_ ` _ \| | '_ \ / _` | | | | || | #
# | |_) | |_| || | (_) | (_) | | | | | | (_| |_| | __/ | | | | | | | | | | | (_| | | |_| || | #
# | .__/ \__, ||_|\___/ \___/|_|_|_| |_|\__, (_)_|\___|_| |_| |_| |_|_|_| |_|\__,_|_|\___/|___| #
# |_| |___/ |___/ #
# ==================================================================================================================== #
# Authors: #
# Patrick Lehmann #
# #
# License: #
# ==================================================================================================================== #
# Copyright 2017-2025 Patrick Lehmann - Bötzingen, Germany #
# Copyright 2007-2016 Patrick Lehmann - Dresden, 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 #
# ==================================================================================================================== #
#
"""pyTooling.TerminalUI"""
from io import StringIO
from unittest import TestCase
from pyTooling.Exceptions import ExceptionBase
from pyTooling.TerminalUI import TerminalBaseApplication
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 Instantiate(TestCase):
def test_NoConfigure(self) -> None:
term = TerminalBaseApplication()
self.assertGreaterEqual(term.Width, 80)
self.assertGreaterEqual(term.Height, 25)
def test_UninitializeColors(self) -> None:
term = TerminalBaseApplication()
term.UninitializeColors()
def test_InitializeColors(self) -> None:
term = TerminalBaseApplication()
term.UninitializeColors()
term.InitializeColors()
def test_ApplicationDerivedFromTerminal(self) -> None:
class Application(TerminalBaseApplication):
def __init__(self) -> None:
super().__init__()
self.__class__.FATAL_EXIT_CODE = 0
app = Application()
class WriteMessages(TestCase):
def test_WriteToStdOut(self) -> None:
term = TerminalBaseApplication()
term._stdout, term._stderr = out, err = StringIO(), StringIO()
term.WriteToStdOut("Message")
out.seek(0)
err.seek(0)
self.assertEqual("Message", out.readline())
self.assertEqual(0, err.tell())
def test_WriteLineToStdOut(self) -> None:
term = TerminalBaseApplication()
term._stdout, term._stderr = out, err = StringIO(), StringIO()
term.WriteLineToStdOut("Message")
out.seek(0)
err.seek(0)
self.assertEqual("Message\n", out.readline())
self.assertEqual(0, err.tell())
def test_WriteToStdErr(self) -> None:
term = TerminalBaseApplication()
term._stdout, term._stderr = out, err = StringIO(), StringIO()
term.WriteToStdErr("Message")
out.seek(0)
err.seek(0)
self.assertEqual(0, out.tell())
self.assertEqual("Message", err.readline())
def test_WriteLineToStdErr(self) -> None:
term = TerminalBaseApplication()
term._stdout, term._stderr = out, err = StringIO(), StringIO()
term.WriteLineToStdErr("Message")
out.seek(0)
err.seek(0)
self.assertEqual(0, out.tell())
self.assertEqual("Message\n", err.readline())
class Exiting(TestCase):
def test_Exit(self) -> None:
term = TerminalBaseApplication()
with self.assertRaises(SystemExit) as ex:
term.Exit(1)
self.assertEqual(1, ex.exception.code)
def test_FatalExit4(self) -> None:
class Application(TerminalBaseApplication):
def __init__(self) -> None:
super().__init__()
app = Application()
with self.assertRaises(SystemExit) as ex:
app.FatalExit(4)
self.assertEqual(4, ex.exception.code)
def test_FatalExit254(self) -> None:
class Application(TerminalBaseApplication):
def __init__(self) -> None:
super().__init__()
self.__class__.FATAL_EXIT_CODE = 254
app = Application()
with self.assertRaises(SystemExit) as ex:
app.FatalExit()
self.assertEqual(254, ex.exception.code)
def test_FatalExitDefault(self) -> None:
class Application(TerminalBaseApplication):
def __init__(self) -> None:
super().__init__()
app = Application()
with self.assertRaises(SystemExit) as ex:
app.FatalExit()
self.assertEqual(255, ex.exception.code)
def test_CheckPythonVersion3(self) -> None:
class Application(TerminalBaseApplication):
def __init__(self) -> None:
super().__init__()
super().CheckPythonVersion((3, 8, 0))
_ = Application()
def test_CheckPythonVersion4(self) -> None:
print()
class Application(TerminalBaseApplication):
def __init__(self) -> None:
super().__init__()
super().CheckPythonVersion((4, 9, 0))
with self.assertRaises(SystemExit) as exitEx:
_ = Application()
self.assertEqual(254, exitEx.exception.code)
class ExceptionHandling(TestCase):
def test_NotImplemented(self) -> None:
print()
class Application(TerminalBaseApplication):
def __init__(self) -> None:
super().__init__()
self.__class__.ISSUE_TRACKER_URL = "https://GitHub.com/pyTooling/pyTooling/issues"
def Run(self):
raise NotImplementedError(f"Abstract method")
app = Application()
try:
app.Run()
except NotImplementedError as ex:
with self.assertRaises(SystemExit) as exitEx:
app.PrintNotImplementedError(ex)
self.assertEqual(240, exitEx.exception.code)
def test_Exception(self) -> None:
print()
class Application(TerminalBaseApplication):
def __init__(self) -> None:
super().__init__()
self.__class__.ISSUE_TRACKER_URL = "https://GitHub.com/pyTooling/pyTooling/issues"
def Run(self):
raise Exception(f"Common exception")
app = Application()
try:
app.Run()
except Exception as ex:
with self.assertRaises(SystemExit) as exitEx:
app.PrintException(ex)
self.assertEqual(241, exitEx.exception.code)
def test_ExceptionWithNestedException(self) -> None:
print()
class Application(TerminalBaseApplication):
def __init__(self) -> None:
super().__init__()
self.__class__.ISSUE_TRACKER_URL = "https://GitHub.com/pyTooling/pyTooling/issues"
def Run(self):
raise Exception(f"Common exception") from FileNotFoundError(f"File doesn't exist.")
app = Application()
try:
app.Run()
except Exception as ex:
with self.assertRaises(SystemExit) as exitEx:
app.PrintException(ex)
self.assertEqual(241, exitEx.exception.code)
def test_ExceptionBase(self) -> None:
print()
class Application(TerminalBaseApplication):
def __init__(self) -> None:
super().__init__()
self.__class__.ISSUE_TRACKER_URL = "https://GitHub.com/pyTooling/pyTooling/issues"
def Run(self):
raise ExceptionBase(f"Base exception")
app = Application()
try:
app.Run()
except ExceptionBase as ex:
with self.assertRaises(SystemExit) as exitEx:
app.PrintExceptionBase(ex)
self.assertEqual(241, exitEx.exception.code)
def test_ExceptionBaseWithNestedException(self) -> None:
print()
class Application(TerminalBaseApplication):
def __init__(self) -> None:
super().__init__()
self.__class__.ISSUE_TRACKER_URL = "https://GitHub.com/pyTooling/pyTooling/issues"
def Run(self):
raise ExceptionBase(f"Base exception") from FileNotFoundError(f"File doesn't exist.")
app = Application()
try:
app.Run()
except ExceptionBase as ex:
with self.assertRaises(SystemExit) as exitEx:
app.PrintExceptionBase(ex)
self.assertEqual(241, exitEx.exception.code)
|
