|
1 | | -API |
2 | | -=== |
| 1 | +# API |
3 | 2 |
|
4 | | -.. module:: click |
| 3 | +```{currentmodule} click |
| 4 | +``` |
5 | 5 |
|
6 | 6 | This part of the documentation lists the full API reference of all public |
7 | 7 | classes and functions. |
8 | 8 |
|
9 | | -.. contents:: |
10 | | - :depth: 1 |
11 | | - :local: |
| 9 | +```{contents} |
| 10 | +:depth: 1 |
| 11 | +:local: true |
| 12 | +``` |
12 | 13 |
|
13 | | -Decorators |
14 | | ----------- |
| 14 | +## Decorators |
15 | 15 |
|
| 16 | +```{eval-rst} |
16 | 17 | .. autofunction:: command |
| 18 | +``` |
17 | 19 |
|
| 20 | +```{eval-rst} |
18 | 21 | .. autofunction:: group |
| 22 | +``` |
19 | 23 |
|
| 24 | +```{eval-rst} |
20 | 25 | .. autofunction:: argument |
| 26 | +``` |
21 | 27 |
|
| 28 | +```{eval-rst} |
22 | 29 | .. autofunction:: option |
| 30 | +``` |
23 | 31 |
|
| 32 | +```{eval-rst} |
24 | 33 | .. autofunction:: password_option |
| 34 | +``` |
25 | 35 |
|
| 36 | +```{eval-rst} |
26 | 37 | .. autofunction:: confirmation_option |
| 38 | +``` |
27 | 39 |
|
| 40 | +```{eval-rst} |
28 | 41 | .. autofunction:: version_option |
| 42 | +``` |
29 | 43 |
|
| 44 | +```{eval-rst} |
30 | 45 | .. autofunction:: help_option |
| 46 | +``` |
31 | 47 |
|
| 48 | +```{eval-rst} |
32 | 49 | .. autofunction:: pass_context |
| 50 | +``` |
33 | 51 |
|
| 52 | +```{eval-rst} |
34 | 53 | .. autofunction:: pass_obj |
| 54 | +``` |
35 | 55 |
|
| 56 | +```{eval-rst} |
36 | 57 | .. autofunction:: make_pass_decorator |
| 58 | +``` |
37 | 59 |
|
| 60 | +```{eval-rst} |
38 | 61 | .. autofunction:: click.decorators.pass_meta_key |
39 | 62 |
|
| 63 | +``` |
40 | 64 |
|
41 | | -Utilities |
42 | | ---------- |
| 65 | +## Utilities |
43 | 66 |
|
| 67 | +```{eval-rst} |
44 | 68 | .. autofunction:: echo |
| 69 | +``` |
45 | 70 |
|
| 71 | +```{eval-rst} |
46 | 72 | .. autofunction:: echo_via_pager |
| 73 | +``` |
47 | 74 |
|
| 75 | +```{eval-rst} |
48 | 76 | .. autofunction:: prompt |
| 77 | +``` |
49 | 78 |
|
| 79 | +```{eval-rst} |
50 | 80 | .. autofunction:: confirm |
| 81 | +``` |
51 | 82 |
|
| 83 | +```{eval-rst} |
52 | 84 | .. autofunction:: progressbar |
| 85 | +``` |
53 | 86 |
|
| 87 | +```{eval-rst} |
54 | 88 | .. autofunction:: clear |
| 89 | +``` |
55 | 90 |
|
| 91 | +```{eval-rst} |
56 | 92 | .. autofunction:: style |
| 93 | +``` |
57 | 94 |
|
| 95 | +```{eval-rst} |
58 | 96 | .. autofunction:: unstyle |
| 97 | +``` |
59 | 98 |
|
| 99 | +```{eval-rst} |
60 | 100 | .. autofunction:: secho |
| 101 | +``` |
61 | 102 |
|
| 103 | +```{eval-rst} |
62 | 104 | .. autofunction:: edit |
| 105 | +``` |
63 | 106 |
|
| 107 | +```{eval-rst} |
64 | 108 | .. autofunction:: launch |
| 109 | +``` |
65 | 110 |
|
| 111 | +```{eval-rst} |
66 | 112 | .. autofunction:: getchar |
| 113 | +``` |
67 | 114 |
|
| 115 | +```{eval-rst} |
68 | 116 | .. autofunction:: pause |
| 117 | +``` |
69 | 118 |
|
| 119 | +```{eval-rst} |
70 | 120 | .. autofunction:: get_binary_stream |
| 121 | +``` |
71 | 122 |
|
| 123 | +```{eval-rst} |
72 | 124 | .. autofunction:: get_text_stream |
| 125 | +``` |
73 | 126 |
|
| 127 | +```{eval-rst} |
74 | 128 | .. autofunction:: open_file |
| 129 | +``` |
75 | 130 |
|
| 131 | +```{eval-rst} |
76 | 132 | .. autofunction:: get_app_dir |
| 133 | +``` |
77 | 134 |
|
| 135 | +```{eval-rst} |
78 | 136 | .. autofunction:: format_filename |
| 137 | +``` |
79 | 138 |
|
80 | | -Commands |
81 | | --------- |
| 139 | +## Commands |
82 | 140 |
|
| 141 | +```{eval-rst} |
83 | 142 | .. autoclass:: BaseCommand |
84 | 143 | :members: |
| 144 | +``` |
85 | 145 |
|
| 146 | +```{eval-rst} |
86 | 147 | .. autoclass:: Command |
87 | 148 | :members: |
| 149 | +``` |
88 | 150 |
|
| 151 | +```{eval-rst} |
89 | 152 | .. autoclass:: MultiCommand |
90 | 153 | :members: |
| 154 | +``` |
91 | 155 |
|
| 156 | +```{eval-rst} |
92 | 157 | .. autoclass:: Group |
93 | 158 | :members: |
| 159 | +``` |
94 | 160 |
|
| 161 | +```{eval-rst} |
95 | 162 | .. autoclass:: CommandCollection |
96 | 163 | :members: |
| 164 | +``` |
97 | 165 |
|
98 | | -Parameters |
99 | | ----------- |
| 166 | +## Parameters |
100 | 167 |
|
| 168 | +```{eval-rst} |
101 | 169 | .. autoclass:: Parameter |
102 | 170 | :members: |
| 171 | +``` |
103 | 172 |
|
| 173 | +```{eval-rst} |
104 | 174 | .. autoclass:: Option |
| 175 | +``` |
105 | 176 |
|
| 177 | +```{eval-rst} |
106 | 178 | .. autoclass:: Argument |
| 179 | +``` |
107 | 180 |
|
108 | | -Context |
109 | | -------- |
| 181 | +## Context |
110 | 182 |
|
| 183 | +```{eval-rst} |
111 | 184 | .. autoclass:: Context |
112 | 185 | :members: |
| 186 | +``` |
113 | 187 |
|
| 188 | +```{eval-rst} |
114 | 189 | .. autofunction:: get_current_context |
| 190 | +``` |
115 | 191 |
|
| 192 | +```{eval-rst} |
116 | 193 | .. autoclass:: click.core.ParameterSource |
117 | 194 | :members: |
118 | 195 | :member-order: bysource |
| 196 | +``` |
119 | 197 |
|
120 | | -.. _click-api-types: |
| 198 | +(click-api-types)= |
121 | 199 |
|
122 | | -Types |
123 | | ------ |
| 200 | +## Types |
124 | 201 |
|
| 202 | +```{eval-rst} |
125 | 203 | .. autodata:: STRING |
| 204 | +``` |
126 | 205 |
|
| 206 | +```{eval-rst} |
127 | 207 | .. autodata:: INT |
| 208 | +``` |
128 | 209 |
|
| 210 | +```{eval-rst} |
129 | 211 | .. autodata:: FLOAT |
| 212 | +``` |
130 | 213 |
|
| 214 | +```{eval-rst} |
131 | 215 | .. autodata:: BOOL |
| 216 | +``` |
132 | 217 |
|
| 218 | +```{eval-rst} |
133 | 219 | .. autodata:: UUID |
| 220 | +``` |
134 | 221 |
|
| 222 | +```{eval-rst} |
135 | 223 | .. autodata:: UNPROCESSED |
| 224 | +``` |
136 | 225 |
|
| 226 | +```{eval-rst} |
137 | 227 | .. autoclass:: File |
| 228 | +``` |
138 | 229 |
|
| 230 | +```{eval-rst} |
139 | 231 | .. autoclass:: Path |
| 232 | +``` |
140 | 233 |
|
| 234 | +```{eval-rst} |
141 | 235 | .. autoclass:: Choice |
142 | 236 | :members: |
| 237 | +``` |
143 | 238 |
|
| 239 | +```{eval-rst} |
144 | 240 | .. autoclass:: IntRange |
| 241 | +``` |
145 | 242 |
|
| 243 | +```{eval-rst} |
146 | 244 | .. autoclass:: FloatRange |
| 245 | +``` |
147 | 246 |
|
| 247 | +```{eval-rst} |
148 | 248 | .. autoclass:: DateTime |
| 249 | +``` |
149 | 250 |
|
| 251 | +```{eval-rst} |
150 | 252 | .. autoclass:: Tuple |
| 253 | +``` |
151 | 254 |
|
| 255 | +```{eval-rst} |
152 | 256 | .. autoclass:: ParamType |
153 | 257 | :members: |
| 258 | +``` |
154 | 259 |
|
155 | | -Exceptions |
156 | | ----------- |
| 260 | +## Exceptions |
157 | 261 |
|
| 262 | +```{eval-rst} |
158 | 263 | .. autoexception:: ClickException |
| 264 | +``` |
159 | 265 |
|
| 266 | +```{eval-rst} |
160 | 267 | .. autoexception:: Abort |
| 268 | +``` |
161 | 269 |
|
| 270 | +```{eval-rst} |
162 | 271 | .. autoexception:: UsageError |
| 272 | +``` |
163 | 273 |
|
| 274 | +```{eval-rst} |
164 | 275 | .. autoexception:: BadParameter |
| 276 | +``` |
165 | 277 |
|
| 278 | +```{eval-rst} |
166 | 279 | .. autoexception:: FileError |
| 280 | +``` |
167 | 281 |
|
| 282 | +```{eval-rst} |
168 | 283 | .. autoexception:: NoSuchOption |
| 284 | +``` |
169 | 285 |
|
| 286 | +```{eval-rst} |
170 | 287 | .. autoexception:: BadOptionUsage |
| 288 | +``` |
171 | 289 |
|
| 290 | +```{eval-rst} |
172 | 291 | .. autoexception:: BadArgumentUsage |
| 292 | +``` |
173 | 293 |
|
174 | | -Formatting |
175 | | ----------- |
| 294 | +## Formatting |
176 | 295 |
|
| 296 | +```{eval-rst} |
177 | 297 | .. autoclass:: HelpFormatter |
178 | 298 | :members: |
| 299 | +``` |
179 | 300 |
|
| 301 | +```{eval-rst} |
180 | 302 | .. autofunction:: wrap_text |
| 303 | +``` |
181 | 304 |
|
182 | | -Parsing |
183 | | -------- |
| 305 | +## Parsing |
184 | 306 |
|
| 307 | +```{eval-rst} |
185 | 308 | .. autoclass:: OptionParser |
186 | 309 | :members: |
187 | 310 |
|
| 311 | +``` |
188 | 312 |
|
189 | | -Shell Completion |
190 | | ----------------- |
| 313 | +## Shell Completion |
191 | 314 |
|
192 | | -See :doc:`/shell-completion` for information about enabling and |
| 315 | +See {doc}`/shell-completion` for information about enabling and |
193 | 316 | customizing Click's shell completion system. |
194 | 317 |
|
| 318 | +```{eval-rst} |
195 | 319 | .. currentmodule:: click.shell_completion |
| 320 | +``` |
196 | 321 |
|
| 322 | +```{eval-rst} |
197 | 323 | .. autoclass:: CompletionItem |
| 324 | +``` |
198 | 325 |
|
| 326 | +```{eval-rst} |
199 | 327 | .. autoclass:: ShellComplete |
200 | 328 | :members: |
201 | 329 | :member-order: bysource |
| 330 | +``` |
202 | 331 |
|
| 332 | +```{eval-rst} |
203 | 333 | .. autofunction:: add_completion_class |
204 | 334 |
|
| 335 | +``` |
205 | 336 |
|
206 | | -.. _testing: |
| 337 | +(testing)= |
207 | 338 |
|
208 | | -Testing |
209 | | -------- |
| 339 | +## Testing |
210 | 340 |
|
| 341 | +```{eval-rst} |
211 | 342 | .. currentmodule:: click.testing |
| 343 | +``` |
212 | 344 |
|
| 345 | +```{eval-rst} |
213 | 346 | .. autoclass:: CliRunner |
214 | 347 | :members: |
| 348 | +``` |
215 | 349 |
|
| 350 | +```{eval-rst} |
216 | 351 | .. autoclass:: Result |
217 | 352 | :members: |
| 353 | +``` |
0 commit comments