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
|
from typing import Optional
import click
import pytest
import cloup
from cloup import Color, Group, HelpTheme, Style
from cloup._util import first_bool, identity, reindent
from cloup.styling import IStyle
from cloup.typing import MISSING
@pytest.fixture(params=["section", "init_arg"])
def cli(request) -> cloup.Group:
@cloup.command(aliases=['i', 'add'])
@cloup.argument('pkg')
def install(pkg: str):
"""Install a package."""
print('install', pkg)
@cloup.group(aliases=['conf', 'cfg'])
def config():
"""Manage the configuration."""
print('config')
@cloup.command(aliases=['clr'], cls=click.Command)
def clear():
"""Remove all installed packages."""
print('clear')
if request.param == "section":
@cloup.group()
def cli():
"""A package installer."""
cli.section("Commands", install, clear, config, is_sorted=True)
elif request.param == "init_arg":
cli = Group(
name="cli",
help="A package installer.",
commands=[install, clear, config],
)
else:
raise ValueError(request.param)
return cli
cli_help_without_aliases = reindent("""
Usage: cli [OPTIONS] COMMAND [ARGS]...
A package installer.
Options:
--help Show this message and exit.
Commands:
clear Remove all installed packages.
config Manage the configuration.
install Install a package.
""")
cli_help_with_aliases = reindent("""
Usage: cli [OPTIONS] COMMAND [ARGS]...
A package installer.
Options:
--help Show this message and exit.
Commands:
clear (clr) Remove all installed packages.
config (conf, cfg) Manage the configuration.
install (i, add) Install a package.
""")
def test_command_aliases_are_stored_in_the_command(cli):
assert cli.commands['install'].aliases == ['i', 'add']
assert cli.commands['clear'].aliases == ['clr']
def test_simple_command_name_resolution(cli):
ctx = cloup.Context(command=cli)
assert cli.resolve_command_name(ctx, 'install') == 'install'
assert cli.resolve_command_name(ctx, 'i') == 'install'
assert cli.resolve_command_name(ctx, 'add') == 'install'
assert cli.resolve_command_name(ctx, 'config') == 'config'
assert cli.resolve_command_name(ctx, 'conf') == 'config'
assert cli.resolve_command_name(ctx, 'clear') == 'clear'
assert cli.resolve_command_name(ctx, 'clr') == 'clear'
def test_command_name_resolution_with_token_normalization_function(cli):
ctx = cloup.Context(command=cli, token_normalize_func=str.lower)
assert cli.resolve_command_name(ctx, 'INSTALL') == 'install'
assert cli.resolve_command_name(ctx, 'ADD') == 'install'
assert cli.resolve_command_name(ctx, 'CLR') == 'clear'
assert cli.resolve_command_name(ctx, 'cONF') == 'config'
@pytest.mark.parametrize('alias', ['install', 'i', 'add'])
def test_command_resolution_with_cloup_subcommand(cli, runner, alias):
res = runner.invoke(cli, [alias, 'cloup'])
assert res.output.strip() == 'install cloup'
@pytest.mark.parametrize('alias', ['clear', 'clr'])
def test_command_resolution_with_click_subcommand(cli, runner, alias):
res = runner.invoke(cli, [alias])
assert res.output.strip() == 'clear'
@pytest.mark.parametrize(
'cmd_value', [MISSING, None, True, False],
ids=lambda val: f'cmd_{val}'
)
@pytest.mark.parametrize(
'ctx_value', [MISSING, None, True, False],
ids=lambda val: f'ctx_{val}'
)
def test_show_subcommand_aliases_setting(cli, runner, ctx_value, cmd_value):
if ctx_value is not MISSING:
cli.context_settings['show_subcommand_aliases'] = ctx_value
if cmd_value is not MISSING:
cli.show_subcommand_aliases = cmd_value
should_show_aliases = first_bool(cmd_value, ctx_value, Group.SHOW_SUBCOMMAND_ALIASES)
expected_help = (cli_help_with_aliases
if should_show_aliases
else cli_help_without_aliases)
res = runner.invoke(cli, ['--help'])
assert res.output == expected_help
def test_cloup_subcommand_help(cli, runner):
res = runner.invoke(cli, ['i', '--help'])
# 1. Shows the full subcommand name even if an alias was used.
# 2. Shows aliases after help text.
expected = reindent("""
Usage: cli install [OPTIONS] PKG
Aliases: i, add
Install a package.
Options:
--help Show this message and exit.
""")
assert res.output == expected
def test_click_subcommand_help(cli, runner):
res = runner.invoke(cli, ['clr', '--help'])
# Shows the full subcommand name even if an alias was used.
# Aliases are not shown (need Cloup commands for that).
expected = reindent("""
Usage: cli clear [OPTIONS]
Remove all installed packages.
Options:
--help Show this message and exit.
""")
assert res.output == expected
def test_cloup_subgroup_help(cli, runner):
res = runner.invoke(cli, ['conf', '--help'])
# 1. Shows the full subcommand name even if an alias was used.
# 2. Shows aliases after help text.
expected = reindent("""
Usage: cli config [OPTIONS] COMMAND [ARGS]...
Aliases: conf, cfg
Manage the configuration.
Options:
--help Show this message and exit.
""")
assert res.output == expected
def test_alias_are_correctly_styled(runner):
red = Style(fg=Color.red)
green = Style(fg=Color.green)
def fmt(alias: IStyle = identity, alias_secondary: Optional[IStyle] = None):
theme = HelpTheme(alias=alias, alias_secondary=alias_secondary)
return Group.format_subcommand_aliases(["i", "add"], theme)
# No styles (default theme)
assert fmt() == "(i, add)"
# Only theme.alias
assert fmt(alias=green) == f"{green('(i, add)')}"
# Only theme.alias_secondary
assert fmt(alias_secondary=green) == (
green("(") + "i" + green(", ") + "add" + green(")")
)
# Both
assert fmt(alias=red, alias_secondary=green) == (
green("(") + red("i") + green(", ") + red("add") + green(")")
)
|
