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
|
API Reference
#############
Command
=======
.. py:class:: Command(name=None)
A ``Command`` represents a single CLI command.
.. py:method:: argument(key=None)
Get the value of a command argument.
:param key: The argument name
:type key: str
:rtype: mixed
.. py:method:: ask(question, default=None)
Prompt the user for input.
:param question: The question to ask
:type question: str
:param default: The default value
:type default: str or None
:rtype: str
.. py:method:: call(name, options=None)
Call another command.
:param name: The command name
:type name: str
:param options: The options
:type options: list or None
.. py:method:: call_silent(name, options=None)
Call another command silently.
:param name: The command name
:type name: str
:param options: The options
:type options: list or None
.. py:method:: choice(question, choices, default=None, attempts=None, multiple=False)
Give the user a single choice from an list of answers.
:param question: The question to ask
:type question: str
:param choices: The available choices
:type choices: list
:param default: The default value
:type default: str or None
:param attempts: The max number of attempts
:type attempts: int
:param multiple: Multiselect
:type multiple: int
:rtype: str
.. py:method:: comment(text)
Write a string as comment output.
:param text: The line to write
:type text: str
.. py:method:: confirm(self, question, default=False, true_answer_regex='(?i)^y')
Confirm a question with the user.
:param question: The question to ask
:type question: str
:param default: The default value
:type default: bool
:param true_answer_regex: A regex to match the "yes" answer
:type true_answer_regex: str
:rtype: bool
.. py:method:: error(text)
Write a string as error output.
:param text: The line to write
:type text: str
.. py:method:: info(text)
Write a string as information output.
:param text: The line to write
:type text: str
.. py:method:: line(text, style=None, verbosity=None)
Write a string as information output.
:param text: The line to write
:type text: str
:param style: The style of the string
:type style: str
:param verbosity: The verbosity
:type verbosity: None or int str
.. py:method:: list(elements)
Write a list of elements.
:param elements: The elements to write a list for
:type elements: list
.. py:method:: option(key=None)
Get the value of a command option.
:param key: The option name
:type key: str
:rtype: mixed
.. py:method:: progress_bar(max=0)
Create a new progress bar
:param max: The maximum number of steps
:type max: int
:rtype: ProgressBar
.. py:method:: question(text)
Write a string as question output.
:param text: The line to write
:type text: str
.. py:method:: render_table(headers, rows, style='default')
Format input to textual table..
:param headers: The table headers
:type headers: list
:param rows: The table rows
:type rows: list
:param style: The table style
:type style: str
.. py:method:: secret(question)
Prompt the user for input but hide the answer from the console.
:param question: The question to ask
:type question: str
:rtype: str
.. py:method:: set_style(name, fg=None, bg=None, options=None)
Set a new style
:param name: The name of the style
:type name: str
:param fg: The foreground color
:type fg: str
:param bg: The background color
:type bg: str
:param options: The options
:type options: list
.. py:method:: table(headers=None, rows=None, style='default')
Return a ``Table`` instance.
:param headers: The table headers
:type headers: list
:param rows: The table rows
:type rows: list
:param style: The table style
:type style: str
.. py:method:: table_cell(value, **options)
Return a ``TableCell`` instance
:param value: The cell value
:type value: str
:param options: The cell options
:type options: dict
.. py:method:: table_separator()
Return a ``TableSeparator`` instance
:rtype: TableSeparator
.. py:method:: table_style()
Return a ``TableStyle`` instance
:rtype: TableStyle
.. py:method:: warning(text)
Write a string as warning output.
:param text: The line to write
:type text: str
|
