cloup._params
¶
Classes¶
|
|
|
A click.Option with an extra field |
Functions¶
|
|
|
Attaches an |
Attributes¶
Alias of |
Contents¶
- class cloup._params.Argument(*args, help=None, **attrs)[source]¶
Bases:
click.Argument
Arguments are positional parameters to a command. They generally provide fewer features than options but can have infinite
nargs
and are required by default.All parameters are passed onwards to the parameter constructor.
- class cloup._params.Option(*args, group=None, **attrs)[source]¶
Bases:
click.Option
A click.Option with an extra field
group
of typeOptionGroup
.
- cloup._params.GroupedOption¶
Alias of
Option
.
- cloup._params.option(*param_decls, cls=None, group=None, **kwargs)[source]¶
Attaches an
Option
to the command. Refer toclick.Option
andclick.Parameter
for more info about the accepted parameters.In your IDE, you won’t see arguments that has to do with shell completion, because they are different in Click 7 and 8 (both supported by Cloup):
in Click 7, it’s
autocompletion
in Click 8, it’s
shell_complete
.
These arguments have different semantics, refer to Click’s docs.