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
|
from typing import Annotated
import pytest
from cyclopts import (
Group,
Parameter,
UnknownOptionError,
)
from cyclopts.exceptions import CoercionError
@pytest.mark.parametrize(
"cmd_str,expected",
[
("--my-flag", True),
("--my-flag=true", True),
("--my-flag=false", False),
("--no-my-flag", False),
],
)
def test_boolean_flag_default(app, cmd_str, expected, assert_parse_args):
@app.default
def foo(my_flag: bool = True):
pass
assert_parse_args(foo, cmd_str, expected)
def test_boolean_flag_app_parameter_default(app, assert_parse_args):
app.default_parameter = Parameter(negative="")
@app.default
def foo(my_flag: bool = True):
pass
# Normal positive flag should still work.
assert_parse_args(foo, "--my-flag", True)
with pytest.raises(UnknownOptionError) as e:
app.parse_args("--no-my-flag", exit_on_error=False)
assert str(e.value) == 'Unknown option: "--no-my-flag". Did you mean "--my-flag"?'
def test_boolean_flag_app_parameter_negative(app, assert_parse_args):
@app.default
def foo(my_flag: Annotated[bool, Parameter("", negative="--no-my-flag")] = True):
pass
assert_parse_args(foo, "--no-my-flag", False)
with pytest.raises(UnknownOptionError):
app.parse_args("--my-flag", exit_on_error=False, print_error=True)
assert_parse_args(foo, "--no-my-flag=True", False)
assert_parse_args(foo, "--no-my-flag=False", True)
with pytest.raises(CoercionError):
app("--no-my-flag=", exit_on_error=False)
def test_boolean_flag_app_parameter_default_annotated_override(app, assert_parse_args):
app.default_parameter = Parameter(negative="")
@app.default
def foo(my_flag: Annotated[bool, Parameter(negative="--NO-flag")] = True):
pass
assert_parse_args(foo, "--my-flag", True)
assert_parse_args(foo, "--NO-flag", False)
def test_boolean_flag_app_parameter_default_nested_annotated_override(app, assert_parse_args):
app.default_parameter = Parameter(negative="")
def my_converter(type_, tokens):
return 5
my_int = Annotated[int, Parameter(converter=my_converter)]
@app.default
def foo(*, foo: Annotated[my_int, Parameter(name="--bar")] = True): # pyright: ignore[reportInvalidTypeForm]
pass
assert_parse_args(foo, "--bar=10", foo=5)
def test_boolean_flag_group_default_parameter_resolution_1(app, assert_parse_args):
food_group = Group("Food", default_parameter=Parameter(negative_bool="group-"))
@app.default
def foo(flag: Annotated[bool, Parameter(group=food_group)]):
pass
assert_parse_args(foo, "--group-flag", False)
@pytest.mark.parametrize(
"cmd_str,expected",
[
("--bar", True),
("--no-bar", False),
],
)
def test_boolean_flag_custom_positive(app, cmd_str, expected, assert_parse_args):
@app.default
def foo(my_flag: Annotated[bool, Parameter(name="--bar")] = True):
pass
assert_parse_args(foo, cmd_str, expected)
@pytest.mark.parametrize(
"cmd_str,expected",
[
("--bar", True),
("--no-bar", False),
],
)
def test_boolean_flag_custom_short_positive(app, cmd_str, expected, assert_parse_args):
@app.default
def foo(my_flag: Annotated[bool, Parameter(name=["--bar", "-b"])] = True):
pass
assert_parse_args(foo, cmd_str, expected)
@pytest.mark.parametrize(
"cmd_str,expected",
[
("--my-flag", True),
("--yesnt-my-flag", False),
],
)
def test_boolean_flag_custom_negative(app, cmd_str, expected, assert_parse_args):
@app.default
def foo(my_flag: Annotated[bool, Parameter(negative="--yesnt-my-flag")] = True):
pass
assert_parse_args(foo, cmd_str, expected)
@pytest.mark.parametrize(
"negative",
["", (), []],
)
def test_boolean_flag_disable_negative(app, negative, assert_parse_args):
@app.default
def foo(my_flag: Annotated[bool, Parameter(negative=negative)] = True):
pass
assert_parse_args(foo, "--my-flag", True)
with pytest.raises(UnknownOptionError):
assert_parse_args(foo, "--no-my-flag", True)
|
