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
|
from textwrap import dedent
from typing import Annotated
import pytest
from cyclopts import App, Parameter
@pytest.mark.parametrize(
"cmd_str",
[
"1 --b 2 --c=c-value-manual --meta-flag",
"1 --b=2 --c=c-value-manual --meta-flag",
"1 --b=2 --c c-value-manual --meta-flag",
],
)
def test_meta_basic(app, cmd_str):
@app.default
def foo(a: int, b: int, c="c-value"):
assert a == 1
assert b == 2
assert c == "c-value-manual"
@app.meta.default
def meta(*tokens: Annotated[str, Parameter(allow_leading_hyphen=True)], meta_flag: bool = False):
assert meta_flag
app(tokens)
app.meta(cmd_str)
def test_meta_app_config_inheritance(app):
app.config = ("foo", "bar")
assert app.meta.config == ("foo", "bar")
@pytest.fixture
def queue():
return []
@pytest.fixture
def nested_meta_app(queue, console):
subapp = App(console=console)
@subapp.meta.default
def subapp_meta(*tokens: Annotated[str, Parameter(show=False, allow_leading_hyphen=True)]) -> None:
"""This is subapp's help."""
queue.append("subapp meta")
subapp(tokens)
@subapp.command
def foo(value: int) -> None:
"""Subapp foo help string.
Parameters
----------
value: int
The value a user inputted.
"""
queue.append(f"subapp foo body {value}")
app = App(name="test_app", console=console)
app.command(subapp.meta, name="subapp")
@app.meta.default
def meta(*tokens: Annotated[str, Parameter(show=False, allow_leading_hyphen=True)]):
queue.append("root meta")
app(tokens)
return app
def test_meta_app_nested_root_help(nested_meta_app, console, queue):
with console.capture() as capture:
nested_meta_app.meta(["--help"])
actual = capture.get()
expected = dedent(
"""\
Usage: test_app COMMAND
╭─ Commands ─────────────────────────────────────────────────────────╮
│ subapp This is subapp's help. │
│ --help -h Display this message and exit. │
│ --version Display application version. │
╰────────────────────────────────────────────────────────────────────╯
"""
)
assert actual == expected
assert not queue
def test_meta_app_nested_subapp_help(nested_meta_app, console, queue):
with console.capture() as capture:
nested_meta_app.meta(["subapp", "--help"])
actual = capture.get()
expected = dedent(
"""\
Usage: test_app subapp COMMAND [ARGS]
This is subapp's help.
╭─ Commands ─────────────────────────────────────────────────────────╮
│ foo Subapp foo help string. │
╰────────────────────────────────────────────────────────────────────╯
"""
)
assert actual == expected
assert not queue
def test_meta_app_nested_subapp_foo_help(nested_meta_app, console, queue):
with console.capture() as capture:
nested_meta_app.meta(["subapp", "foo", "--help"])
actual = capture.get()
expected = dedent(
"""\
Usage: test_app subapp foo [ARGS] [OPTIONS]
Subapp foo help string.
╭─ Parameters ───────────────────────────────────────────────────────╮
│ * VALUE --value The value a user inputted. [required] │
╰────────────────────────────────────────────────────────────────────╯
"""
)
assert actual == expected
assert not queue
@pytest.mark.parametrize(
"cmd_str,expected",
[
("", ["root meta"]),
("subapp", ["root meta", "subapp meta"]),
("subapp foo 5", ["root meta", "subapp meta", "subapp foo body 5"]),
],
)
def test_meta_app_nested_exec(nested_meta_app, queue, cmd_str, expected):
nested_meta_app.meta(cmd_str)
assert queue == expected
|
