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
|
import pytest
from clikit.api.args.format import Option
def test_create():
opt = Option("option")
assert "option" == opt.long_name
assert opt.short_name is None
assert opt.is_long_name_preferred()
assert not opt.is_short_name_preferred()
assert not opt.accepts_value()
assert not opt.is_value_required()
assert not opt.is_value_optional()
assert not opt.is_multi_valued()
assert opt.default is None
assert "..." == opt.value_name
def test_dashed_long_name():
opt = Option("--option")
assert "option" == opt.long_name
def test_fail_if_long_name_is_null():
with pytest.raises(ValueError):
Option(None)
def test_fail_if_long_name_is_empty():
with pytest.raises(ValueError):
Option("")
def test_fail_if_long_name_is_not_a_string():
with pytest.raises(ValueError):
Option(1234)
def test_fail_if_long_name_contains_spaces():
with pytest.raises(ValueError):
Option("foo bar")
def test_fail_if_long_name_starts_with_number():
with pytest.raises(ValueError):
Option("1option")
def test_fail_if_long_name_is_one_character():
with pytest.raises(ValueError):
Option("o")
def test_fail_if_long_name_starts_with_single_hyphen():
with pytest.raises(ValueError):
Option("-option")
def test_fail_if_long_name_starts_with_three_hyphens():
with pytest.raises(ValueError):
Option("-option")
@pytest.mark.parametrize(
"flags",
[
Option.NO_VALUE | Option.OPTIONAL_VALUE,
Option.NO_VALUE | Option.REQUIRED_VALUE,
Option.NO_VALUE | Option.MULTI_VALUED,
Option.PREFER_LONG_NAME | Option.PREFER_SHORT_NAME,
Option.STRING | Option.BOOLEAN,
Option.STRING | Option.INTEGER,
Option.STRING | Option.FLOAT,
Option.BOOLEAN | Option.INTEGER,
Option.BOOLEAN | Option.FLOAT,
Option.INTEGER | Option.FLOAT,
],
)
def test_fail_if_invalid_flag_combination(flags):
with pytest.raises(ValueError):
Option("option", "o", flags)
def test_short_name():
opt = Option("option", "o")
assert "o" == opt.short_name
def test_dashed_short_name():
opt = Option("option", "-o")
assert "o" == opt.short_name
def test_fail_if_short_name_is_empty():
with pytest.raises(ValueError):
Option("option", "")
def test_fail_if_short_name_is_not_string():
with pytest.raises(ValueError):
Option("option", 1234)
def test_fail_if_short_name_is_longer_than_one_letter():
with pytest.raises(ValueError):
Option("option", "ab")
def test_no_value():
opt = Option("option", flags=Option.NO_VALUE)
assert not opt.accepts_value()
assert not opt.is_value_required()
assert not opt.is_value_optional()
assert not opt.is_multi_valued()
assert opt.default is None
def test_fail_if_no_value_and_default_value():
with pytest.raises(ValueError):
Option("option", flags=Option.NO_VALUE, default="Default")
def test_optional_value():
opt = Option("option", flags=Option.OPTIONAL_VALUE)
assert opt.accepts_value()
assert not opt.is_value_required()
assert opt.is_value_optional()
assert not opt.is_multi_valued()
assert opt.default is None
def test_optional_value_with_default():
opt = Option("option", flags=Option.OPTIONAL_VALUE, default="Default")
assert opt.accepts_value()
assert not opt.is_value_required()
assert opt.is_value_optional()
assert not opt.is_multi_valued()
assert "Default" == opt.default
def test_required_value():
opt = Option("option", flags=Option.REQUIRED_VALUE)
assert opt.accepts_value()
assert opt.is_value_required()
assert not opt.is_value_optional()
assert not opt.is_multi_valued()
assert opt.default is None
def test_required_value_with_default():
opt = Option("option", flags=Option.REQUIRED_VALUE, default="Default")
assert opt.accepts_value()
assert opt.is_value_required()
assert not opt.is_value_optional()
assert not opt.is_multi_valued()
assert "Default" == opt.default
def test_multi_valued():
opt = Option("option", flags=Option.MULTI_VALUED)
assert opt.accepts_value()
assert opt.is_value_required()
assert not opt.is_value_optional()
assert opt.is_multi_valued()
assert [] == opt.default
def test_multi_valued_with_default():
opt = Option("option", flags=Option.MULTI_VALUED, default=["foo", "bar"])
assert opt.accepts_value()
assert opt.is_value_required()
assert not opt.is_value_optional()
assert opt.is_multi_valued()
assert ["foo", "bar"] == opt.default
def test_fail_if_multi_valued_with_default_not_list():
with pytest.raises(ValueError):
Option("option", flags=Option.MULTI_VALUED, default="Default")
@pytest.mark.parametrize(
"flags, string, output",
[
(0, "", ""),
(0, "string", "string"),
(0, "1", "1"),
(0, "1.23", "1.23"),
(0, "null", "null"),
(Option.NULLABLE, "null", None),
(0, "true", "true"),
(0, "false", "false"),
(Option.STRING, "", ""),
(Option.STRING, "string", "string"),
(Option.STRING, "1", "1"),
(Option.STRING, "1.23", "1.23"),
(Option.STRING, "null", "null"),
(Option.STRING | Option.NULLABLE, "null", None),
(Option.STRING, "true", "true"),
(Option.STRING, "false", "false"),
(Option.BOOLEAN, "true", True),
(Option.BOOLEAN, "false", False),
(Option.BOOLEAN | Option.NULLABLE, "null", None),
(Option.INTEGER, "1", 1),
(Option.INTEGER, "0", 0),
(Option.INTEGER | Option.NULLABLE, "null", None),
(Option.FLOAT, "1", 1.0),
(Option.FLOAT, "1.23", 1.23),
(Option.FLOAT, "0", 0.0),
(Option.FLOAT | Option.NULLABLE, "null", None),
],
)
def test_parse_value(flags, string, output):
arg = Option("option", flags=flags)
assert output == arg.parse(string)
@pytest.mark.parametrize(
"flags, string",
[(Option.BOOLEAN, "null"), (Option.INTEGER, "null"), (Option.FLOAT, "null")],
)
def test_parse_value_fails_if_invalid(flags, string):
arg = Option("argument", flags=flags)
with pytest.raises(ValueError):
arg.parse(string)
|
