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
|
# stdlib
import sys
from typing import Iterable
# 3rd party
import click
from pytest_regressions.file_regression import FileRegressionFixture
# this package
from consolekit import click_command
from consolekit.options import (
DescribedArgument,
MultiValueOption,
auto_default_argument,
auto_default_option,
colour_option,
flag_option,
force_option,
no_pager_option,
verbose_option,
version_option
)
from consolekit.terminal_colours import ColourTrilean
from consolekit.testing import CliRunner, Result
def test_described_argument(
file_regression: FileRegressionFixture,
cli_runner: CliRunner,
):
@click.argument(
"dest",
cls=DescribedArgument,
type=click.STRING,
description="The destination directory.",
)
@click_command()
def main(dest: str) -> None:
print(dest)
result = cli_runner.invoke(main, args="--help")
result.check_stdout(file_regression, extension=".md")
assert result.exit_code == 0
result = cli_runner.invoke(main, catch_exceptions=False, args="./staging")
assert result.stdout.rstrip() == "./staging"
assert result.exit_code == 0
ctx = click.Context(main, info_name="main", parent=None)
argument = ctx.command.params[0]
assert isinstance(argument, DescribedArgument)
assert argument.description == "The destination directory."
def test_auto_default_option(
file_regression: FileRegressionFixture,
cli_runner: CliRunner,
):
@auto_default_option(
"--width",
type=click.INT,
help="The max width to display.",
show_default=True,
)
@click_command()
def main(width: int = 80) -> None:
print(width)
argument = main.params[0]
assert argument.default == 80
assert not argument.required
assert argument.show_default # type: ignore[attr-defined]
result = cli_runner.invoke(main, args="--help")
result.check_stdout(file_regression, extension=".md")
assert result.exit_code == 0
result = cli_runner.invoke(main, catch_exceptions=False)
assert result.stdout.rstrip() == "80"
assert result.exit_code == 0
for width in [0, 8, 36, 48, 130]:
result = cli_runner.invoke(main, args=["--width", str(width)])
assert result.stdout.rstrip() == str(width)
assert result.exit_code == 0
def test_flag_option(cli_runner: CliRunner):
@flag_option("--no-colour")
@click_command()
def main(no_colour: bool) -> None:
print(no_colour)
result = cli_runner.invoke(main, catch_exceptions=False)
assert result.stdout.rstrip() == "False"
assert result.exit_code == 0
result = cli_runner.invoke(main, args="--no-colour")
assert result.stdout.rstrip() == "True"
assert result.exit_code == 0
def test_no_pager_option(file_regression: FileRegressionFixture, cli_runner: CliRunner):
@no_pager_option()
@click_command()
def main(no_pager: bool) -> None:
print(no_pager)
result = cli_runner.invoke(main, catch_exceptions=False)
assert result.stdout.rstrip() == "False"
assert result.exit_code == 0
result = cli_runner.invoke(main, args="--no-pager")
assert result.stdout.rstrip() == "True"
assert result.exit_code == 0
result = cli_runner.invoke(main, args="-h")
result.check_stdout(file_regression)
assert result.exit_code == 0
def test_force_option(file_regression: FileRegressionFixture, cli_runner: CliRunner):
@force_option("Force the operation")
@click_command()
def main(force: bool) -> None:
print(force)
result = cli_runner.invoke(main, catch_exceptions=False)
assert result.stdout.rstrip() == "False"
assert result.exit_code == 0
result = cli_runner.invoke(main, args="--force")
assert result.stdout.rstrip() == "True"
assert result.exit_code == 0
result = cli_runner.invoke(main, args="-f")
assert result.stdout.rstrip() == "True"
assert result.exit_code == 0
result = cli_runner.invoke(main, args="-h")
result.check_stdout(file_regression)
assert result.exit_code == 0
def test_verbose_option(file_regression: FileRegressionFixture, cli_runner: CliRunner):
@verbose_option("Show verbose output.")
@click_command()
def main(verbose: int) -> None:
print(verbose)
result = cli_runner.invoke(main)
assert result.stdout.rstrip() == '0'
assert result.exit_code == 0
result = cli_runner.invoke(main, args="--verbose")
assert result.stdout.rstrip() == '1'
assert result.exit_code == 0
result = cli_runner.invoke(main, args="-v")
assert result.stdout.rstrip() == '1'
assert result.exit_code == 0
result = cli_runner.invoke(main, args=["--verbose", "--verbose"])
assert result.stdout.rstrip() == '2'
assert result.exit_code == 0
result = cli_runner.invoke(main, args="-vv")
assert result.stdout.rstrip() == '2'
assert result.exit_code == 0
result = cli_runner.invoke(main, args="-vvv")
assert result.stdout.rstrip() == '3'
assert result.exit_code == 0
result = cli_runner.invoke(main, args="-h")
result.check_stdout(file_regression)
assert result.exit_code == 0
def test_colour_option(file_regression: FileRegressionFixture, cli_runner: CliRunner):
@colour_option()
@click_command()
def main(colour: ColourTrilean) -> None:
print(colour)
result = cli_runner.invoke(main, catch_exceptions=False)
assert result.stdout.rstrip() == "None"
assert result.exit_code == 0
result = cli_runner.invoke(main, args="--no-colour")
assert result.stdout.rstrip() == "False"
assert result.exit_code == 0
result = cli_runner.invoke(main, args="--colour")
assert result.stdout.rstrip() == "True"
assert result.exit_code == 0
result = cli_runner.invoke(main, args="-h")
result.check_stdout(file_regression)
assert result.exit_code == 0
def test_version_option(file_regression: FileRegressionFixture, cli_runner: CliRunner):
def version_callback(ctx: click.Context, param: click.Option, value: int) -> None:
if not value or ctx.resilient_parsing:
return
if value > 1:
click.echo("consolekit version 1.2.3, Python 3.8.5")
else:
click.echo("consolekit version 1.2.3")
ctx.exit()
@version_option(version_callback)
@click_command()
def main() -> None:
sys.exit(1)
result = cli_runner.invoke(main, args="--version")
assert result.stdout.rstrip() == "consolekit version 1.2.3"
assert result.exit_code == 0
result = cli_runner.invoke(main, args=["--version", "--version"])
assert result.stdout.rstrip() == "consolekit version 1.2.3, Python 3.8.5"
assert result.exit_code == 0
def test_multi_value_option(cli_runner: CliRunner):
@click.option(
"--select",
type=click.STRING,
help="The checks to enable",
cls=MultiValueOption,
)
@colour_option()
@click_command()
def main(select: Iterable[str], colour: bool) -> None:
select = list(select)
print(*select)
print(", ".join(select))
result: Result = cli_runner.invoke(main, catch_exceptions=False)
assert result.stdout.rstrip() == ''
assert result.exit_code == 0
result = cli_runner.invoke(main, args=["--select", "E102", "F223"])
assert result.stdout.rstrip() == "E102 F223\nE102, F223"
assert result.exit_code == 0
result = cli_runner.invoke(main, args=["--select", "E102", "F223", "--colour"])
assert result.stdout.rstrip() == "E102 F223\nE102, F223"
assert result.exit_code == 0
result = cli_runner.invoke(main, args=["--select", "E102"])
assert result.stdout.rstrip() == "E102\nE102"
assert result.exit_code == 0
def test_multi_value_option_int(cli_runner: CliRunner):
@click.option("--value", help="Some values", cls=MultiValueOption, type=int, default=(1, 2, 3))
@colour_option()
@click_command()
def main(value: Iterable[int], colour: bool) -> None:
print(value)
result: Result = cli_runner.invoke(main, catch_exceptions=False)
assert result.stdout.rstrip() == "(1, 2, 3)"
assert result.exit_code == 0
result = cli_runner.invoke(main, args=["--value", '4', '5', '6'])
assert result.stdout.rstrip() == "(4, 5, 6)"
assert result.exit_code == 0
def test_auto_default_argument(cli_runner: CliRunner):
@auto_default_argument(
"greeting",
type=click.STRING,
)
@click_command()
def main(greeting: str = "Hello") -> None:
print(f"{greeting} User!")
argument = main.params[0]
assert argument.default == "Hello"
assert not argument.required
result = cli_runner.invoke(main)
assert result.stdout.rstrip() == "Hello User!"
assert result.exit_code == 0
result = cli_runner.invoke(main, args=["Good Morning"])
assert result.stdout.rstrip() == "Good Morning User!"
assert result.exit_code == 0
|
