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
|
import argparse
import textwrap
from decli import cli
def main_example() -> argparse.ArgumentParser:
"""https://docs.python.org/3/library/argparse.html#example"""
data = {
"description": "Process some integers.",
"arguments": [
{
"name": "integers",
"metavar": "N",
"type": int,
"nargs": "+",
"help": "an integer for the accumulator",
},
{
"name": "--sum",
"dest": "accumulate",
"action": "store_const",
"const": sum,
"default": max,
"help": "sum the integers (default: find the max)",
},
],
}
parser = cli(data)
return parser
def complete_example() -> argparse.ArgumentParser:
data = {
"prog": "cz",
"formatter_class": argparse.RawDescriptionHelpFormatter,
"description": "The software does this and that",
"epilog": "This is the epilooogpoe ",
"arguments": [
{
"name": "--debug",
"action": "store_true",
"default": False,
"help": "use debug mode",
},
{
"name": ["-v", "--version"],
"action": "store_true",
"default": False,
"help": "get the installed version",
"group": "ops",
},
{"name": "--save", "group": "ops"},
],
"subcommands": {
"title": "main",
"description": "main commands",
"commands": [
{
"name": "all",
"help": "check every values is true",
"func": all,
},
{
"name": ["sum", "s"],
"help": "new project",
"func": sum,
"arguments": [
{
"name": "integers",
"metavar": "N",
"type": int,
"nargs": "+",
"help": "an integer for the accumulator",
},
{"name": "--name", "nargs": "?"},
],
},
],
},
}
parser = cli(data)
return parser
def name_or_flags() -> dict:
"""https://docs.python.org/3/library/argparse.html#name-or-flags"""
data = {
"prog": "sti",
"arguments": [{"name": ["-f", "--foo"]}, {"name": "bar"}],
}
return data
def compose_clis_using_parents() -> list[argparse.ArgumentParser]:
"""
Sometimes, several cli share a common set of arguments.
Rather than repeating the definitions of these arguments,
one or more parent clis with all the shared arguments can be passed
to parents= argument to cli.
https://docs.python.org/3/library/argparse.html#parents
"""
parent_foo_data = {
"add_help": False,
"arguments": [{"name": "--foo-parent", "type": int}],
}
parent_bar_data = {
"add_help": False,
"arguments": [{"name": "--bar-parent", "type": int}],
}
parent_foo_cli = cli(parent_foo_data)
parent_bar_cli = cli(parent_bar_data)
parents = [parent_foo_cli, parent_bar_cli]
return parents
def using_formatter_class() -> dict:
"""https://docs.python.org/3/library/argparse.html#formatter-class"""
data = {
"prog": "PROG",
"formatter_class": argparse.RawDescriptionHelpFormatter,
"description": textwrap.dedent(
"""\
Please do not mess up this text!
--------------------------------
I have indented it
exactly the way
I want it
"""
),
}
return data
def prefix_chars() -> dict:
data = {
"prog": "PROG",
"prefix_chars": "+",
"arguments": [{"name": ["+f", "++foo"]}, {"name": "++bar"}],
}
return data
def grouping_arguments() -> dict:
data = {
"prog": "mycli",
"arguments": [
{
"name": "--new",
"help": "This does not belong to a group but its a long help",
},
{
"name": "--init",
"help": "This does not belong to a group but its a long help",
},
{
"name": "--run",
"group": "app",
"help": "This does not belong to a group",
},
{
"name": "--build",
"group": "app",
"help": "This does not belong to a group",
},
{
"name": ["--install", "--add"],
"group": "package",
"metavar": "package_name",
"nargs": "+",
"help": "This belongs to a group",
},
{
"name": "--remove",
"group": "package",
"help": "This belongs to a group",
},
{
"name": "--why",
"group": "package",
"help": "This belongs to a group",
},
],
}
return data
def exclusive_group() -> dict:
data = {
"prog": "app",
"arguments": [
{"name": "--install", "exclusive_group": "ops"},
{"name": "--purge", "exclusive_group": "ops"},
],
}
return data
|
