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
|
import dataclasses
import sys
from unittest import mock
from unittest.mock import patch
import pytest
from rich.style import Style
if sys.platform == "win32":
from rich import _win32_console
from rich._win32_console import COORD, LegacyWindowsTerm, WindowsCoordinates
CURSOR_X = 1
CURSOR_Y = 2
CURSOR_POSITION = WindowsCoordinates(row=CURSOR_Y, col=CURSOR_X)
SCREEN_WIDTH = 20
SCREEN_HEIGHT = 30
DEFAULT_STYLE_ATTRIBUTE = 16
CURSOR_SIZE = 25
@dataclasses.dataclass
class StubScreenBufferInfo:
dwCursorPosition: COORD = COORD(CURSOR_X, CURSOR_Y)
dwSize: COORD = COORD(SCREEN_WIDTH, SCREEN_HEIGHT)
wAttributes: int = DEFAULT_STYLE_ATTRIBUTE
pytestmark = pytest.mark.skipif(sys.platform != "win32", reason="windows only")
def test_windows_coordinates_to_ctype():
coord = WindowsCoordinates.from_param(WindowsCoordinates(row=1, col=2))
assert coord.X == 2
assert coord.Y == 1
@pytest.fixture
def win32_handle():
handle = mock.sentinel
with mock.patch.object(_win32_console, "GetStdHandle", return_value=handle):
yield handle
@pytest.fixture
def win32_console_getters():
def stub_console_cursor_info(std_handle, cursor_info):
cursor_info.dwSize = CURSOR_SIZE
cursor_info.bVisible = True
with mock.patch.object(
_win32_console,
"GetConsoleScreenBufferInfo",
return_value=StubScreenBufferInfo,
) as GetConsoleScreenBufferInfo, mock.patch.object(
_win32_console, "GetConsoleCursorInfo", side_effect=stub_console_cursor_info
) as GetConsoleCursorInfo:
yield {
"GetConsoleScreenBufferInfo": GetConsoleScreenBufferInfo,
"GetConsoleCursorInfo": GetConsoleCursorInfo,
}
def test_cursor_position(win32_console_getters):
term = LegacyWindowsTerm(sys.stdout)
assert term.cursor_position == WindowsCoordinates(row=CURSOR_Y, col=CURSOR_X)
def test_screen_size(win32_console_getters):
term = LegacyWindowsTerm(sys.stdout)
assert term.screen_size == WindowsCoordinates(
row=SCREEN_HEIGHT, col=SCREEN_WIDTH
)
def test_write_text(win32_console_getters, win32_handle, capsys):
text = "Hello, world!"
term = LegacyWindowsTerm(sys.stdout)
term.write_text(text)
captured = capsys.readouterr()
assert captured.out == text
@patch.object(_win32_console, "SetConsoleTextAttribute")
def test_write_styled(
SetConsoleTextAttribute,
win32_console_getters,
win32_handle,
capsys,
):
style = Style.parse("black on red")
text = "Hello, world!"
term = LegacyWindowsTerm(sys.stdout)
term.write_styled(text, style)
captured = capsys.readouterr()
assert captured.out == text
# Ensure we set the text attributes and then reset them after writing styled text
call_args = SetConsoleTextAttribute.call_args_list
assert len(call_args) == 2
first_args, first_kwargs = call_args[0]
second_args, second_kwargs = call_args[1]
assert first_args == (win32_handle,)
assert first_kwargs["attributes"].value == 64
assert second_args == (win32_handle,)
assert second_kwargs["attributes"] == DEFAULT_STYLE_ATTRIBUTE
@patch.object(_win32_console, "SetConsoleTextAttribute")
def test_write_styled_bold(
SetConsoleTextAttribute, win32_console_getters, win32_handle
):
style = Style.parse("bold black on red")
text = "Hello, world!"
term = LegacyWindowsTerm(sys.stdout)
term.write_styled(text, style)
call_args = SetConsoleTextAttribute.call_args_list
first_args, first_kwargs = call_args[0]
expected_attr = 64 + 8 # 64 for red bg, +8 for bright black
assert first_args == (win32_handle,)
assert first_kwargs["attributes"].value == expected_attr
@patch.object(_win32_console, "SetConsoleTextAttribute")
def test_write_styled_reverse(
SetConsoleTextAttribute, win32_console_getters, win32_handle
):
style = Style.parse("reverse red on blue")
text = "Hello, world!"
term = LegacyWindowsTerm(sys.stdout)
term.write_styled(text, style)
call_args = SetConsoleTextAttribute.call_args_list
first_args, first_kwargs = call_args[0]
expected_attr = 64 + 1 # 64 for red bg (after reverse), +1 for blue fg
assert first_args == (win32_handle,)
assert first_kwargs["attributes"].value == expected_attr
@patch.object(_win32_console, "SetConsoleTextAttribute")
def test_write_styled_reverse(
SetConsoleTextAttribute, win32_console_getters, win32_handle
):
style = Style.parse("dim bright_red on blue")
text = "Hello, world!"
term = LegacyWindowsTerm(sys.stdout)
term.write_styled(text, style)
call_args = SetConsoleTextAttribute.call_args_list
first_args, first_kwargs = call_args[0]
expected_attr = 4 + 16 # 4 for red text (after dim), +16 for blue bg
assert first_args == (win32_handle,)
assert first_kwargs["attributes"].value == expected_attr
@patch.object(_win32_console, "SetConsoleTextAttribute")
def test_write_styled_no_foreground_color(
SetConsoleTextAttribute, win32_console_getters, win32_handle
):
style = Style.parse("on blue")
text = "Hello, world!"
term = LegacyWindowsTerm(sys.stdout)
term.write_styled(text, style)
call_args = SetConsoleTextAttribute.call_args_list
first_args, first_kwargs = call_args[0]
expected_attr = 16 | term._default_fore # 16 for blue bg, plus default fg color
assert first_args == (win32_handle,)
assert first_kwargs["attributes"].value == expected_attr
@patch.object(_win32_console, "SetConsoleTextAttribute")
def test_write_styled_no_background_color(
SetConsoleTextAttribute, win32_console_getters, win32_handle
):
style = Style.parse("blue")
text = "Hello, world!"
term = LegacyWindowsTerm(sys.stdout)
term.write_styled(text, style)
call_args = SetConsoleTextAttribute.call_args_list
first_args, first_kwargs = call_args[0]
expected_attr = (
16 | term._default_back
) # 16 for blue foreground, plus default bg color
assert first_args == (win32_handle,)
assert first_kwargs["attributes"].value == expected_attr
@patch.object(_win32_console, "FillConsoleOutputCharacter", return_value=None)
@patch.object(_win32_console, "FillConsoleOutputAttribute", return_value=None)
def test_erase_line(
FillConsoleOutputAttribute,
FillConsoleOutputCharacter,
win32_console_getters,
win32_handle,
):
term = LegacyWindowsTerm(sys.stdout)
term.erase_line()
start = WindowsCoordinates(row=CURSOR_Y, col=0)
FillConsoleOutputCharacter.assert_called_once_with(
win32_handle, " ", length=SCREEN_WIDTH, start=start
)
FillConsoleOutputAttribute.assert_called_once_with(
win32_handle, DEFAULT_STYLE_ATTRIBUTE, length=SCREEN_WIDTH, start=start
)
@patch.object(_win32_console, "FillConsoleOutputCharacter", return_value=None)
@patch.object(_win32_console, "FillConsoleOutputAttribute", return_value=None)
def test_erase_end_of_line(
FillConsoleOutputAttribute,
FillConsoleOutputCharacter,
win32_console_getters,
win32_handle,
):
term = LegacyWindowsTerm(sys.stdout)
term.erase_end_of_line()
FillConsoleOutputCharacter.assert_called_once_with(
win32_handle, " ", length=SCREEN_WIDTH - CURSOR_X, start=CURSOR_POSITION
)
FillConsoleOutputAttribute.assert_called_once_with(
win32_handle,
DEFAULT_STYLE_ATTRIBUTE,
length=SCREEN_WIDTH - CURSOR_X,
start=CURSOR_POSITION,
)
@patch.object(_win32_console, "FillConsoleOutputCharacter", return_value=None)
@patch.object(_win32_console, "FillConsoleOutputAttribute", return_value=None)
def test_erase_start_of_line(
FillConsoleOutputAttribute,
FillConsoleOutputCharacter,
win32_console_getters,
win32_handle,
):
term = LegacyWindowsTerm(sys.stdout)
term.erase_start_of_line()
start = WindowsCoordinates(CURSOR_Y, 0)
FillConsoleOutputCharacter.assert_called_once_with(
win32_handle, " ", length=CURSOR_X, start=start
)
FillConsoleOutputAttribute.assert_called_once_with(
win32_handle, DEFAULT_STYLE_ATTRIBUTE, length=CURSOR_X, start=start
)
@patch.object(_win32_console, "SetConsoleCursorPosition", return_value=None)
def test_move_cursor_to(
SetConsoleCursorPosition, win32_console_getters, win32_handle
):
coords = WindowsCoordinates(row=4, col=5)
term = LegacyWindowsTerm(sys.stdout)
term.move_cursor_to(coords)
SetConsoleCursorPosition.assert_called_once_with(win32_handle, coords=coords)
@patch.object(_win32_console, "SetConsoleCursorPosition", return_value=None)
def test_move_cursor_to_out_of_bounds_row(
SetConsoleCursorPosition, win32_console_getters, win32_handle
):
coords = WindowsCoordinates(row=-1, col=4)
term = LegacyWindowsTerm(sys.stdout)
term.move_cursor_to(coords)
assert not SetConsoleCursorPosition.called
@patch.object(_win32_console, "SetConsoleCursorPosition", return_value=None)
def test_move_cursor_to_out_of_bounds_col(
SetConsoleCursorPosition, win32_console_getters, win32_handle
):
coords = WindowsCoordinates(row=10, col=-4)
term = LegacyWindowsTerm(sys.stdout)
term.move_cursor_to(coords)
assert not SetConsoleCursorPosition.called
@patch.object(_win32_console, "SetConsoleCursorPosition", return_value=None)
def test_move_cursor_up(
SetConsoleCursorPosition, win32_console_getters, win32_handle
):
term = LegacyWindowsTerm(sys.stdout)
term.move_cursor_up()
SetConsoleCursorPosition.assert_called_once_with(
win32_handle, coords=WindowsCoordinates(row=CURSOR_Y - 1, col=CURSOR_X)
)
@patch.object(_win32_console, "SetConsoleCursorPosition", return_value=None)
def test_move_cursor_down(
SetConsoleCursorPosition, win32_console_getters, win32_handle
):
term = LegacyWindowsTerm(sys.stdout)
term.move_cursor_down()
SetConsoleCursorPosition.assert_called_once_with(
win32_handle, coords=WindowsCoordinates(row=CURSOR_Y + 1, col=CURSOR_X)
)
@patch.object(_win32_console, "SetConsoleCursorPosition", return_value=None)
def test_move_cursor_forward(
SetConsoleCursorPosition, win32_console_getters, win32_handle
):
term = LegacyWindowsTerm(sys.stdout)
term.move_cursor_forward()
SetConsoleCursorPosition.assert_called_once_with(
win32_handle, coords=WindowsCoordinates(row=CURSOR_Y, col=CURSOR_X + 1)
)
@patch.object(_win32_console, "SetConsoleCursorPosition", return_value=None)
def test_move_cursor_forward_newline_wrap(
SetConsoleCursorPosition, win32_console_getters, win32_handle
):
cursor_at_end_of_line = StubScreenBufferInfo(
dwCursorPosition=COORD(SCREEN_WIDTH - 1, CURSOR_Y)
)
win32_console_getters[
"GetConsoleScreenBufferInfo"
].return_value = cursor_at_end_of_line
term = LegacyWindowsTerm(sys.stdout)
term.move_cursor_forward()
SetConsoleCursorPosition.assert_called_once_with(
win32_handle, coords=WindowsCoordinates(row=CURSOR_Y + 1, col=0)
)
@patch.object(_win32_console, "SetConsoleCursorPosition", return_value=None)
def test_move_cursor_to_column(
SetConsoleCursorPosition, win32_console_getters, win32_handle
):
term = LegacyWindowsTerm(sys.stdout)
term.move_cursor_to_column(5)
SetConsoleCursorPosition.assert_called_once_with(
win32_handle, coords=WindowsCoordinates(CURSOR_Y, 5)
)
@patch.object(_win32_console, "SetConsoleCursorPosition", return_value=None)
def test_move_cursor_backward(
SetConsoleCursorPosition, win32_console_getters, win32_handle
):
term = LegacyWindowsTerm(sys.stdout)
term.move_cursor_backward()
SetConsoleCursorPosition.assert_called_once_with(
win32_handle, coords=WindowsCoordinates(row=CURSOR_Y, col=CURSOR_X - 1)
)
@patch.object(_win32_console, "SetConsoleCursorPosition", return_value=None)
def test_move_cursor_backward_prev_line_wrap(
SetConsoleCursorPosition, win32_console_getters, win32_handle
):
cursor_at_start_of_line = StubScreenBufferInfo(
dwCursorPosition=COORD(0, CURSOR_Y)
)
win32_console_getters[
"GetConsoleScreenBufferInfo"
].return_value = cursor_at_start_of_line
term = LegacyWindowsTerm(sys.stdout)
term.move_cursor_backward()
SetConsoleCursorPosition.assert_called_once_with(
win32_handle,
coords=WindowsCoordinates(row=CURSOR_Y - 1, col=SCREEN_WIDTH - 1),
)
@patch.object(_win32_console, "SetConsoleCursorInfo", return_value=None)
def test_hide_cursor(SetConsoleCursorInfo, win32_console_getters, win32_handle):
term = LegacyWindowsTerm(sys.stdout)
term.hide_cursor()
call_args = SetConsoleCursorInfo.call_args_list
assert len(call_args) == 1
args, kwargs = call_args[0]
assert kwargs["cursor_info"].bVisible == 0
assert kwargs["cursor_info"].dwSize == CURSOR_SIZE
@patch.object(_win32_console, "SetConsoleCursorInfo", return_value=None)
def test_show_cursor(SetConsoleCursorInfo, win32_console_getters, win32_handle):
term = LegacyWindowsTerm(sys.stdout)
term.show_cursor()
call_args = SetConsoleCursorInfo.call_args_list
assert len(call_args) == 1
args, kwargs = call_args[0]
assert kwargs["cursor_info"].bVisible == 1
assert kwargs["cursor_info"].dwSize == CURSOR_SIZE
@patch.object(_win32_console, "SetConsoleTitle", return_value=None)
def test_set_title(SetConsoleTitle, win32_console_getters):
term = LegacyWindowsTerm(sys.stdout)
term.set_title("title")
SetConsoleTitle.assert_called_once_with("title")
@patch.object(_win32_console, "SetConsoleTitle", return_value=None)
def test_set_title_too_long(_, win32_console_getters):
term = LegacyWindowsTerm(sys.stdout)
with pytest.raises(AssertionError):
term.set_title("a" * 255)
|
