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
|
from dataclasses import dataclass
from enum import Enum, auto
from textwrap import dedent
from typing import Annotated
import pytest
from cyclopts import App, Parameter, default_name_transform
@pytest.mark.parametrize(
"before,after",
[
("FOO", "foo"),
("_FOO", "foo"),
("_FOO_", "foo"),
("_F_O_O_", "f-o-o"),
],
)
def test_default_name_transform(before, after):
assert default_name_transform(before) == after
def test_app_name_transform_default(app):
@app.command
def _F_O_O_(): # noqa: N802
pass
assert "f-o-o" in app
def test_app_name_transform_custom(app):
def name_transform(s: str) -> str:
return "my-custom-name-transform"
app.name_transform = name_transform
@app.command
def foo():
pass
assert "my-custom-name-transform" in app
def test_subapp_name_transform_custom(app):
"""A subapp with an explicitly set ``name_transform`` should NOT inherit from parent."""
def name_transform_1(s: str) -> str:
return "my-custom-name-transform-1"
def name_transform_2(s: str) -> str:
return "my-custom-name-transform-2"
app.name_transform = name_transform_1
app.command(subapp := App(name="bar", name_transform=name_transform_2))
@subapp.command
def foo():
pass
assert "my-custom-name-transform-2" in subapp
def test_subapp_name_transform_custom_inherited(app):
"""A subapp without an explicitly set ``name_transform`` should inherit it from the first parent."""
def name_transform(s: str) -> str:
return "my-custom-name-transform"
app.name_transform = name_transform
app.command(subapp := App(name="bar"))
@subapp.command
def foo():
pass
assert "my-custom-name-transform" in subapp
def test_parameter_name_transform_default(app, assert_parse_args):
@app.default
def foo(*, b_a_r: int):
pass
assert_parse_args(foo, "--b-a-r 5", b_a_r=5)
def test_parameter_name_transform_custom(app, assert_parse_args):
app.default_parameter = Parameter(name_transform=lambda s: s)
@app.default
def foo(*, b_a_r: int):
pass
assert_parse_args(foo, "--b_a_r 5", b_a_r=5)
@pytest.mark.parametrize("transform", [None, lambda s: s])
def test_parameter_name_transform_kwargs(app, assert_parse_args, transform):
"""Both custom and non-custom transforms should result in the same kwargs."""
app.default_parameter = Parameter(name_transform=transform)
@app.default
def foo(**kwargs: int):
pass
assert_parse_args(foo, "--hy-phen=1 --under_score=2", **{"hy-phen": 1, "under_score": 2})
def test_parameter_name_transform_custom_name_override(app, assert_parse_args):
app.default_parameter = Parameter(name_transform=lambda s: s)
@app.default
def foo(*, b_a_r: Annotated[int, Parameter(name="--buzz")]):
pass
assert_parse_args(foo, "--buzz 5", b_a_r=5)
def test_parameter_name_transform_custom_enum(app, assert_parse_args):
"""name_transform should also be applied to enum options."""
app.default_parameter = Parameter(name_transform=lambda s: s)
class SoftwareEnvironment(Enum):
DEV = auto()
STAGING = auto()
PROD = auto()
_PROD_OLD = auto()
@app.default
def foo(*, b_a_r: SoftwareEnvironment = SoftwareEnvironment.STAGING):
pass
assert_parse_args(foo, "--b_a_r PROD", b_a_r=SoftwareEnvironment.PROD)
def test_parameter_name_transform_help(app, console):
app.default_parameter = Parameter(name_transform=lambda s: s)
@app.default
def foo(*, b_a_r: int):
pass
with console.capture() as capture:
app.help_print([], console=console)
actual = capture.get()
expected = dedent(
"""\
Usage: foo COMMAND [OPTIONS]
╭─ Commands ─────────────────────────────────────────────────────────╮
│ --help -h Display this message and exit. │
│ --version Display application version. │
╰────────────────────────────────────────────────────────────────────╯
╭─ Parameters ───────────────────────────────────────────────────────╮
│ * --b_a_r [required] │
╰────────────────────────────────────────────────────────────────────╯
"""
)
assert actual == expected
def test_parameter_name_transform_help_enum(app, console):
"""name_transform should also be applied to enum options on help page."""
app.default_parameter = Parameter(name_transform=lambda s: s)
class CompSciProblem(Enum):
FIZZ = "bleep bloop blop"
BUZZ = "blop bleep bloop"
@app.command
def cmd(
foo: Annotated[CompSciProblem, Parameter(help="Docstring for foo.")] = CompSciProblem.FIZZ,
bar: Annotated[CompSciProblem, Parameter(help="Docstring for bar.")] = CompSciProblem.BUZZ,
):
pass
with console.capture() as capture:
app.help_print(["cmd"], console=console)
actual = capture.get()
expected = dedent(
"""\
Usage: test_name_transform cmd [ARGS] [OPTIONS]
╭─ Parameters ───────────────────────────────────────────────────────╮
│ FOO --foo Docstring for foo. [choices: FIZZ, BUZZ] [default: │
│ FIZZ] │
│ BAR --bar Docstring for bar. [choices: FIZZ, BUZZ] [default: │
│ BUZZ] │
╰────────────────────────────────────────────────────────────────────╯
"""
)
assert actual == expected
def test_parameter_name_transform_dataclass(app, assert_parse_args):
app.default_parameter = Parameter(name_transform=lambda s: s.upper())
@dataclass
class Color:
red: int
green: int
blue: int
@dataclass
class User:
name: str
favorite_color: Color
@app.default
def default(user: Annotated[User, Parameter(name="--user")]):
pass
assert_parse_args(
default,
"Bob --user.FAVORITE_COLOR.RED=100 --user.FAVORITE_COLOR.GREEN=200 --user.FAVORITE_COLOR.BLUE=255",
User("Bob", Color(100, 200, 255)),
)
|
