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
|
# stdlib
import math
import os
import shutil
import sys
from typing import Tuple
# 3rd party
import click
from coincidence.regressions import AdvancedDataRegressionFixture, check_file_regression
from coincidence.selectors import not_windows
from domdf_python_tools.paths import PathPlus
from domdf_python_tools.utils import redirect_output
from pytest_regressions.file_regression import FileRegressionFixture
# this package
import consolekit
from consolekit import click_command
from consolekit.terminal_colours import ColourTrilean
from consolekit.utils import (
abort,
coloured_diff,
hidden_cursor,
hide_cursor,
import_commands,
is_command,
long_echo,
overtype,
show_cursor,
solidus_spinner
)
def test_overtype(capsys):
print("Waiting...", end='')
overtype("foo", "bar")
sys.stdout.flush()
captured = capsys.readouterr()
stdout = captured.out.split('\n')
assert stdout == ["Waiting...\rfoo bar"]
print("Waiting...", end='')
overtype("foo", "bar", sep='')
sys.stdout.flush()
captured = capsys.readouterr()
stdout = captured.out.split('\n')
assert stdout == ["Waiting...\rfoobar"]
print("Waiting...", end='')
overtype("foo", "bar", sep='-', end='\n')
sys.stdout.flush()
captured = capsys.readouterr()
stdout = captured.out.split('\n')
assert stdout == ["Waiting...\rfoo-bar", '']
sys.stderr.write("Waiting...")
overtype("foo", "bar", file=sys.stderr)
sys.stdout.flush()
captured = capsys.readouterr()
stderr = captured.err.split('\n')
assert stderr == ["Waiting...\rfoo bar"]
def test_coloured_diff(file_regression: FileRegressionFixture):
data_dir = PathPlus(__file__).parent / "test_diff_"
original = data_dir / "original"
modified = data_dir / "modified"
diff = coloured_diff(
original.read_lines(),
modified.read_lines(),
fromfile="original_file.txt",
tofile="modified_file.txt",
fromfiledate="(original)",
tofiledate="(modified)",
lineterm='',
)
check_file_regression(diff, file_regression)
def test_is_command():
@click_command()
def main() -> None: ...
assert is_command(main)
assert not is_command(int)
assert not is_command(lambda: True)
assert not is_command(math.ceil)
def test_hidden_cursor(monkeypatch, capsys, advanced_data_regression: AdvancedDataRegressionFixture):
monkeypatch.setattr(consolekit.terminal_colours, "resolve_color_default", lambda *args: True)
hide_cursor()
show_cursor()
with hidden_cursor():
click.echo(f"\r{next(solidus_spinner)}", nl=False)
click.echo(f"\r{next(solidus_spinner)}", nl=False)
click.echo(f"\r{next(solidus_spinner)}", nl=False)
advanced_data_regression.check(tuple(capsys.readouterr()))
def test_import_commands():
# this package
from tests import import_commands_demo
commands = import_commands(import_commands_demo)
assert commands == [
import_commands_demo.command1,
import_commands_demo.commando,
import_commands_demo.submodule.command2,
import_commands_demo.submodule.group2,
]
def test_long_echo(monkeypatch):
def get_terminal_size(fallback: Tuple[int, int] = (80, 24)) -> Tuple[int, int]:
return os.terminal_size((80, 5))
def echo_via_pager(text_or_generator, color: ColourTrilean = None) -> None: # noqa: MAN001
click.echo('\n'.join(f"|{line}" for line in text_or_generator.splitlines()))
monkeypatch.setattr(shutil, "get_terminal_size", get_terminal_size)
monkeypatch.setattr(click, "echo_via_pager", echo_via_pager)
with redirect_output() as (stdout, stderr):
stdout.isatty = lambda *args: True # type: ignore[assignment]
assert stdout.isatty()
assert sys.stdout.isatty()
long_echo([
"Line 1",
"Line 2",
"Line 3",
"Line 4",
"Line 5",
"Line 6",
])
assert stdout.getvalue() == "|Line 1\n|Line 2\n|Line 3\n|Line 4\n|Line 5\n|Line 6\n"
with redirect_output() as (stdout, stderr):
stdout.isatty = lambda *args: True # type: ignore[assignment]
assert stdout.isatty()
assert sys.stdout.isatty()
long_echo('\n'.join([
"Line 1",
"Line 2",
"Line 3",
"Line 4",
"Line 5",
]))
assert stdout.getvalue() == "Line 1\nLine 2\nLine 3\nLine 4\nLine 5\n"
@not_windows(reason="Output differs on Windows")
def test_abort(capsys):
abort("The program will now abort.", colour=True)
assert capsys.readouterr().err == "\x1b[31mThe program will now abort.\x1b[39m\n"
def test_abort_no_colour(capsys):
abort("The program will now abort.", colour=False)
assert capsys.readouterr().err == "The program will now abort.\n"
|
