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
332
333
334
335
336
337
338
339
340
341
342
343
344
345
|
# coding=utf-8
# flake8: noqa E302
"""
Unit/functional testing for argparse completer in cmd2
"""
import pytest
from cmd2.utils import StdSim
from .conftest import run_cmd, normalize, complete_tester
from examples.tab_autocompletion import TabCompleteExample
@pytest.fixture
def cmd2_app():
app = TabCompleteExample()
app.stdout = StdSim(app.stdout)
return app
SUGGEST_HELP = '''Usage: suggest -t {movie, show} [-h] [-d DURATION{1..2}]
Suggest command demonstrates argparse customizations.
See hybrid_suggest and orig_suggest to compare the help output.
required arguments:
-t, --type {movie, show}
optional arguments:
-h, --help show this help message and exit
-d, --duration DURATION{1..2}
Duration constraint in minutes.
single value - maximum duration
[a, b] - duration range'''
MEDIA_MOVIES_ADD_HELP = '''Usage: media movies add -d DIRECTOR{1..2}
[-h]
title {G, PG, PG-13, R, NC-17} ...
positional arguments:
title Movie Title
{G, PG, PG-13, R, NC-17}
Movie Rating
actor Actors
required arguments:
-d, --director DIRECTOR{1..2}
Director
optional arguments:
-h, --help show this help message and exit'''
def test_help_required_group(cmd2_app):
out1, err1 = run_cmd(cmd2_app, 'suggest -h')
out2, err2 = run_cmd(cmd2_app, 'help suggest')
assert out1 == out2
assert out1[0].startswith('Usage: suggest')
assert out1[1] == ''
assert out1[2].startswith('Suggest command demonstrates argparse customizations.')
assert out1 == normalize(SUGGEST_HELP)
def test_help_required_group_long(cmd2_app):
out1, err1 = run_cmd(cmd2_app, 'media movies add -h')
out2, err2 = run_cmd(cmd2_app, 'help media movies add')
assert out1 == out2
assert out1[0].startswith('Usage: media movies add')
assert out1 == normalize(MEDIA_MOVIES_ADD_HELP)
def test_autocomp_flags(cmd2_app):
text = '-'
line = 'suggest {}'.format(text)
endidx = len(line)
begidx = endidx - len(text)
first_match = complete_tester(text, line, begidx, endidx, cmd2_app)
assert first_match is not None and \
cmd2_app._completion_matches == ['--duration', '--help', '--type', '-d', '-h', '-t']
def test_autcomp_hint(cmd2_app, capsys):
text = ''
line = 'suggest -d {}'.format(text)
endidx = len(line)
begidx = endidx - len(text)
first_match = complete_tester(text, line, begidx, endidx, cmd2_app)
out, err = capsys.readouterr()
assert out == '''
Hint:
-d, --duration DURATION Duration constraint in minutes.
single value - maximum duration
[a, b] - duration range
'''
def test_autcomp_flag_comp(cmd2_app, capsys):
text = '--d'
line = 'suggest {}'.format(text)
endidx = len(line)
begidx = endidx - len(text)
first_match = complete_tester(text, line, begidx, endidx, cmd2_app)
out, err = capsys.readouterr()
assert first_match is not None and \
cmd2_app._completion_matches == ['--duration ']
def test_autocomp_flags_choices(cmd2_app):
text = ''
line = 'suggest -t {}'.format(text)
endidx = len(line)
begidx = endidx - len(text)
first_match = complete_tester(text, line, begidx, endidx, cmd2_app)
assert first_match is not None and \
cmd2_app._completion_matches == ['movie', 'show']
def test_autcomp_hint_in_narg_range(cmd2_app, capsys):
text = ''
line = 'suggest -d 2 {}'.format(text)
endidx = len(line)
begidx = endidx - len(text)
first_match = complete_tester(text, line, begidx, endidx, cmd2_app)
out, err = capsys.readouterr()
assert out == '''
Hint:
-d, --duration DURATION Duration constraint in minutes.
single value - maximum duration
[a, b] - duration range
'''
def test_autocomp_flags_narg_max(cmd2_app):
text = ''
line = 'suggest d 2 3 {}'.format(text)
endidx = len(line)
begidx = endidx - len(text)
first_match = complete_tester(text, line, begidx, endidx, cmd2_app)
assert first_match is None
def test_autcomp_narg_beyond_max(cmd2_app):
out, err = run_cmd(cmd2_app, 'suggest -t movie -d 3 4 5')
assert 'Error: unrecognized arguments: 5' in err[1]
def test_autocomp_subcmd_nested(cmd2_app):
text = ''
line = 'media movies {}'.format(text)
endidx = len(line)
begidx = endidx - len(text)
first_match = complete_tester(text, line, begidx, endidx, cmd2_app)
assert first_match is not None and \
cmd2_app._completion_matches == ['add', 'delete', 'list', 'load']
def test_autocomp_subcmd_flag_choices_append(cmd2_app):
text = ''
line = 'media movies list -r {}'.format(text)
endidx = len(line)
begidx = endidx - len(text)
first_match = complete_tester(text, line, begidx, endidx, cmd2_app)
assert first_match is not None and \
cmd2_app._completion_matches == ['G', 'NC-17', 'PG', 'PG-13', 'R']
def test_autocomp_subcmd_flag_choices_append_exclude(cmd2_app):
text = ''
line = 'media movies list -r PG PG-13 {}'.format(text)
endidx = len(line)
begidx = endidx - len(text)
first_match = complete_tester(text, line, begidx, endidx, cmd2_app)
assert first_match is not None and \
cmd2_app._completion_matches == ['G', 'NC-17', 'R']
def test_autocomp_subcmd_flag_comp_func(cmd2_app):
text = 'A'
line = 'media movies list -a "{}'.format(text)
endidx = len(line)
begidx = endidx - len(text)
first_match = complete_tester(text, line, begidx, endidx, cmd2_app)
assert first_match is not None and \
cmd2_app._completion_matches == ['Adam Driver', 'Alec Guinness', 'Andy Serkis', 'Anthony Daniels']
def test_autocomp_subcmd_flag_comp_list(cmd2_app):
text = 'G'
line = 'media movies list -d {}'.format(text)
endidx = len(line)
begidx = endidx - len(text)
first_match = complete_tester(text, line, begidx, endidx, cmd2_app)
assert first_match is not None and first_match == '"Gareth Edwards'
def test_autocomp_subcmd_flag_comp_func_attr(cmd2_app):
text = 'A'
line = 'video movies list -a "{}'.format(text)
endidx = len(line)
begidx = endidx - len(text)
first_match = complete_tester(text, line, begidx, endidx, cmd2_app)
assert first_match is not None and \
cmd2_app._completion_matches == ['Adam Driver', 'Alec Guinness', 'Andy Serkis', 'Anthony Daniels']
def test_autocomp_subcmd_flag_comp_list_attr(cmd2_app):
text = 'G'
line = 'video movies list -d {}'.format(text)
endidx = len(line)
begidx = endidx - len(text)
first_match = complete_tester(text, line, begidx, endidx, cmd2_app)
assert first_match is not None and first_match == '"Gareth Edwards'
def test_autocomp_pos_consumed(cmd2_app):
text = ''
line = 'library movie add SW_EP01 {}'.format(text)
endidx = len(line)
begidx = endidx - len(text)
first_match = complete_tester(text, line, begidx, endidx, cmd2_app)
assert first_match is None
def test_autocomp_pos_after_flag(cmd2_app):
text = 'Joh'
line = 'video movies add -d "George Lucas" -- "Han Solo" PG "Emilia Clarke" "{}'.format(text)
endidx = len(line)
begidx = endidx - len(text)
first_match = complete_tester(text, line, begidx, endidx, cmd2_app)
assert first_match is not None and \
cmd2_app._completion_matches == ['John Boyega" ']
def test_autocomp_custom_func_list_arg(cmd2_app):
text = 'SW_'
line = 'library show add {}'.format(text)
endidx = len(line)
begidx = endidx - len(text)
first_match = complete_tester(text, line, begidx, endidx, cmd2_app)
assert first_match is not None and \
cmd2_app._completion_matches == ['SW_CW', 'SW_REB', 'SW_TCW']
def test_autocomp_custom_func_list_and_dict_arg(cmd2_app):
text = ''
line = 'library show add SW_REB {}'.format(text)
endidx = len(line)
begidx = endidx - len(text)
first_match = complete_tester(text, line, begidx, endidx, cmd2_app)
assert first_match is not None and \
cmd2_app._completion_matches == ['S01E02', 'S01E03', 'S02E01', 'S02E03']
def test_autocomp_custom_func_dict_arg(cmd2_app):
text = '/home/user/'
line = 'video movies load {}'.format(text)
endidx = len(line)
begidx = endidx - len(text)
first_match = complete_tester(text, line, begidx, endidx, cmd2_app)
assert first_match is not None and \
cmd2_app._completion_matches == ['/home/user/another.db', '/home/user/file space.db', '/home/user/file.db']
def test_argparse_remainder_flag_completion(cmd2_app):
import cmd2
import argparse
# Test flag completion as first arg of positional with nargs=argparse.REMAINDER
text = '--h'
line = 'help command {}'.format(text)
endidx = len(line)
begidx = endidx - len(text)
# --h should not complete into --help because we are in the argparse.REMAINDER section
assert complete_tester(text, line, begidx, endidx, cmd2_app) is None
# Test flag completion within an already started positional with nargs=argparse.REMAINDER
text = '--h'
line = 'help command subcommand {}'.format(text)
endidx = len(line)
begidx = endidx - len(text)
# --h should not complete into --help because we are in the argparse.REMAINDER section
assert complete_tester(text, line, begidx, endidx, cmd2_app) is None
# Test a flag with nargs=argparse.REMAINDER
parser = argparse.ArgumentParser()
parser.add_argument('-f', nargs=argparse.REMAINDER)
# Overwrite eof's parser for this test
cmd2.Cmd.do_eof.argparser = parser
text = '--h'
line = 'eof -f {}'.format(text)
endidx = len(line)
begidx = endidx - len(text)
# --h should not complete into --help because we are in the argparse.REMAINDER section
assert complete_tester(text, line, begidx, endidx, cmd2_app) is None
def test_completion_after_double_dash(cmd2_app):
"""
Test completion after --, which argparse says (all args after -- are non-options)
All of these tests occur outside of an argparse.REMAINDER section since those tests
are handled in test_argparse_remainder_flag_completion
"""
# Test -- as the last token
text = '--'
line = 'help {}'.format(text)
endidx = len(line)
begidx = endidx - len(text)
# Since -- is the last token, then it should show flag choices
first_match = complete_tester(text, line, begidx, endidx, cmd2_app)
assert first_match is not None and '--help' in cmd2_app._completion_matches
# Test -- to end all flag completion
text = '--'
line = 'help -- {}'.format(text)
endidx = len(line)
begidx = endidx - len(text)
# Since -- appeared before the -- being completed, nothing should be completed
assert complete_tester(text, line, begidx, endidx, cmd2_app) is None
|
