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
|
from textwrap import dedent
from typing import Annotated, Union
import pytest
from cyclopts import (
Argument,
ArgumentOrderError,
CoercionError,
InvalidCommandError,
MissingArgumentError,
MixedArgumentError,
Parameter,
Token,
ValidationError,
)
def positive_validator(type_, value):
if value <= 0:
# Seeing if we can translate a ValueError into a ValidationError as helpfully as possible.
raise ValueError("Value must be positive.")
def multi_positive_validator(type_, values):
for value in values:
if value <= 0:
raise ValueError("Value must be positive.")
def test_exceptions_missing_argument_single(app, console):
@app.command
def foo(bar: int):
pass
with console.capture() as capture, pytest.raises(MissingArgumentError):
app("foo", console=console, exit_on_error=False)
actual = capture.get()
expected = dedent(
"""\
╭─ Error ────────────────────────────────────────────────────────────╮
│ Command "foo" parameter "--bar" requires an argument. │
╰────────────────────────────────────────────────────────────────────╯
"""
)
assert actual == expected
def test_exceptions_missing_argument_flag(app, console):
@app.command
def foo(bar: bool):
pass
with console.capture() as capture, pytest.raises(MissingArgumentError):
app("foo", console=console, exit_on_error=False)
actual = capture.get()
expected = dedent(
"""\
╭─ Error ────────────────────────────────────────────────────────────╮
│ Command "foo" parameter "--bar" flag required. │
╰────────────────────────────────────────────────────────────────────╯
"""
)
assert actual == expected
def test_exceptions_validation_error_cli_single_positional(app, console):
argument = Argument(
hint=int,
parameter=Parameter(name=("--bar",), validator=positive_validator),
tokens=[
Token(keyword=None, value="-2", source="cli"),
],
)
with pytest.raises(ValidationError) as e:
argument.convert_and_validate()
expected = dedent(
"""
ValidationError
Invalid value "-2" for "BAR". Value must be positive.
"""
).strip()
assert str(e.value) == expected
def test_exceptions_validation_error_cli_single_keyword(app, console):
argument = Argument(
hint=int,
parameter=Parameter(name=("--bar",), validator=positive_validator),
tokens=[
Token(keyword="--bar", value="-2", source="cli"),
],
)
with pytest.raises(ValidationError) as e:
argument.convert_and_validate()
expected = dedent(
"""
ValidationError
Invalid value "-2" for "--bar". Value must be positive.
"""
).strip()
assert str(e.value) == expected
def test_exceptions_validation_error_non_cli_single_keyword(app, console):
argument = Argument(
hint=int,
parameter=Parameter(name=("--bar",), validator=positive_validator),
tokens=[
Token(value="-2", source="test"),
],
)
with pytest.raises(ValidationError) as e:
argument.convert_and_validate()
expected = dedent(
"""
ValidationError
Invalid value "-2" for "BAR" provided by "test". Value must be positive.
"""
).strip()
assert str(e.value) == expected
def test_exceptions_validation_error_cli_multi_positional(app, console):
argument = Argument(
hint=tuple[int, int],
parameter=Parameter(name=("--bar",), validator=multi_positive_validator),
tokens=[
Token(keyword=None, value="100", source="cli"),
Token(keyword=None, value="-2", source="cli"),
],
)
with pytest.raises(ValidationError) as e:
argument.convert_and_validate()
expected = dedent(
"""
ValidationError
Invalid value "(100, -2)" for "BAR". Value must be positive.
"""
).strip()
assert str(e.value) == expected
def test_exceptions_validation_error_cli_multi_keyword(app, console):
argument = Argument(
hint=tuple[int, int],
parameter=Parameter(name=("--bar",), validator=multi_positive_validator),
tokens=[
Token(keyword="--bar", value="100", source="cli"),
Token(keyword="--bar", value="-2", source="cli"),
],
)
with pytest.raises(ValidationError) as e:
argument.convert_and_validate()
expected = dedent(
"""
ValidationError
Invalid value "(100, -2)" for "--bar". Value must be positive.
"""
).strip()
assert str(e.value) == expected
def test_exceptions_coercion_error_from_positional_cli(app, console):
@app.command
def foo(bar: int):
pass
with console.capture() as capture, pytest.raises(CoercionError):
app("foo fizz", console=console, exit_on_error=False)
actual = capture.get()
expected = dedent(
"""\
╭─ Error ────────────────────────────────────────────────────────────╮
│ Invalid value for "BAR": unable to convert "fizz" into int. │
╰────────────────────────────────────────────────────────────────────╯
"""
)
assert actual == expected
def test_exceptions_coercion_error_from_keyword_cli(app, console):
@app.command
def foo(bar: Annotated[int, Parameter(name=("--bar", "-b"))]):
pass
with console.capture() as capture, pytest.raises(CoercionError):
app("foo -b fizz", console=console, exit_on_error=False)
actual = capture.get()
expected = dedent(
"""\
╭─ Error ────────────────────────────────────────────────────────────╮
│ Invalid value for "-b": unable to convert "fizz" into int. │
╰────────────────────────────────────────────────────────────────────╯
"""
)
assert actual == expected
def test_exceptions_coercion_error_verbose(app, console):
@app.command
def foo(bar: int):
pass
with console.capture() as capture, pytest.raises(CoercionError):
app("foo fizz", console=console, exit_on_error=False, verbose=True)
actual = capture.get()
expected = dedent(
"""\
╭─ Error ────────────────────────────────────────────────────────────╮
│ CoercionError │
"""
)
assert actual.startswith(expected)
expected = dedent(
"""\
│ foo(bar: int) │
│ Root Input Tokens: ['foo', 'fizz'] │
│ Invalid value for "BAR": unable to convert "fizz" into int. │
╰────────────────────────────────────────────────────────────────────╯
"""
)
assert actual.endswith(expected)
def test_exceptions_mixed_argument_error(app, console):
@app.default
def foo(bar: Union[int, dict]):
pass
with console.capture() as capture, pytest.raises(MixedArgumentError):
app("--bar 5 --bar.baz fizz", console=console, exit_on_error=False)
actual = capture.get()
expected = dedent(
"""\
╭─ Error ────────────────────────────────────────────────────────────╮
│ Cannot supply keyword & non-keyword arguments to "--bar". │
╰────────────────────────────────────────────────────────────────────╯
"""
)
assert actual == expected
def test_exceptions_unknown_command(app, console):
@app.command
def foo(bar: int):
pass
with console.capture() as capture, pytest.raises(InvalidCommandError):
app("bar fizz", console=console, exit_on_error=False)
actual = capture.get()
expected = dedent(
"""\
╭─ Error ────────────────────────────────────────────────────────────╮
│ Unknown command "bar". Available commands: foo. │
╰────────────────────────────────────────────────────────────────────╯
"""
)
assert actual == expected
def test_exceptions_argument_order_error_singular(app, console):
@app.command
def foo(a, b, c):
pass
with console.capture() as capture, pytest.raises(ArgumentOrderError):
app("foo --b=5 1 2", console=console, exit_on_error=False)
actual = capture.get()
expected = dedent(
"""\
╭─ Error ────────────────────────────────────────────────────────────╮
│ Cannot specify token '2' positionally for parameter 'c' due to │
│ previously specified keyword '--b'. '--b' must either be passed │
│ positionally, or '2' must be passed as a keyword to '--c'. │
╰────────────────────────────────────────────────────────────────────╯
"""
)
assert actual == expected
def test_exceptions_argument_order_error_plural(app, console):
@app.command
def foo(a, b, c):
pass
with console.capture() as capture, pytest.raises(ArgumentOrderError):
app("foo --a=1 --b=5 3", console=console, exit_on_error=False)
actual = capture.get()
expected = dedent(
"""\
╭─ Error ────────────────────────────────────────────────────────────╮
│ Cannot specify token '3' positionally for parameter 'c' due to │
│ previously specified keywords ['--a', '--b']. ['--a', '--b'] must │
│ either be passed positionally, or '3' must be passed as a keyword │
│ to '--c'. │
╰────────────────────────────────────────────────────────────────────╯
"""
)
assert actual == expected
|
