consolekit.options
Command line options.
New in version 0.4.0.
Classes:
|
|
|
Subclass of |
Data:
Invariant |
|
Invariant |
Functions:
|
Attaches an argument to the command, with a default value determined from the decorated function’s signature. |
|
Attaches an option to the command, with a default value determined from the decorated function’s signature. |
|
Adds an option (via the parameter |
|
Decorator to a flag option to a click command. |
|
Decorator to add the |
|
Decorator to add the |
|
Adds an option (via the parameter |
|
Adds an option to show the version and exit. |
-
class
DescribedArgument(*args, description=None, **kwargs)[source] Bases:
Argumentclick.Argumentwith an additional keyword argument and attribute giving a short description.This is not shown in the help text, but may be useful for manpages or HTML documentation where additional information can be provided.
New in version 1.2.0.
See
click.Argumentandclick.Parameterfor descriptions of the other keyword argu ments.
-
class
MultiValueOption(param_decls=None, show_default=False, help=None, hidden=False, type=None, required=False, default=(), callback=None, metavar=None, expose_value=True, is_eager=False)[source] Bases:
OptionSubclass of
click.Optionthat behaves like argparse’snargs='+'.New in version 0.6.0.
- Parameters
param_decls (
Optional[List[str]]) – The parameter declarations for this option or argument. This is a list of flags or argument names. DefaultNone.show_default (
bool) – Controls whether the default value should be shown on the help page. Normally, defaults are not shown. If this value is a string, it shows the string instead of the value. This is particularly useful for dynamic options. DefaultFalse.hidden (
bool) – Hide this option from help outputs. DefaultFalse.type (
Union[type,ParamType,Tuple[Union[type,ParamType], …],Callable[[str],Any],Callable[[Optional[str]],Any],None]) – The type that should be used. Either aclick.ParamTypeor a Python type. The later is converted into the former automatically if supported. DefaultNone.required (
bool) – Controls whether this is optional. DefaultFalse.default (
Optional[Any]) – The default value if omitted. This can also be a callable, in which case it is invoked when the default is needed without any arguments. Default().callback (
Optional[Callable[[Context,Parameter,str],Any]]) – A callback that should be executed after the parameter was matched. This is called asfn(ctx, param, value)and needs to return the value. DefaultNone.metavar (
Optional[str]) – How the value is represented in the help page. DefaultNone.expose_value (
bool) – IfTruethen the value is passed onwards to the command callback and stored on the context, otherwise it is skipped. DefaultTrue.is_eager (
bool) – Eager values are processed before non eager ones. DefaultFalse.
Example usage:
@click.option( "--select", type=click.STRING, help="The checks to enable", cls=MultiValueOption, ) @click_command() def main(select: Iterable[str]): select = list(select)
Methods:
add_to_parser(parser, ctx)Add the
MultiValueOptionto the given parser.process_value(ctx, value)Given a value and context, converts the value as necessary.
-
add_to_parser(parser, ctx)[source] Add the
MultiValueOptionto the given parser.- Parameters
parser (
OptionParser)ctx (
Context)
- Return type
-
_A= TypeVar(_A, bound=Argument) Type:
TypeVarInvariant
TypeVarbound toclick.Argument.
-
_C= TypeVar(_C, bound=Command) Type:
TypeVarInvariant
TypeVarbound toclick.Command.
-
auto_default_argument(*param_decls, **attrs)[source] Attaches an argument to the command, with a default value determined from the decorated function’s signature.
All positional arguments are passed as parameter declarations to
click.Argument; all keyword arguments are forwarded unchanged (exceptcls). This is equivalent to creating anclick.Argumentinstance manually and attaching it to theclick.Command.paramslist.New in version 0.8.0.
- Parameters
cls – the option class to instantiate. This defaults to
click.Argument.- Return type
-
auto_default_option(*param_decls, **attrs)[source] Attaches an option to the command, with a default value determined from the decorated function’s signature.
All positional arguments are passed as parameter declarations to
click.Option; all keyword arguments are forwarded unchanged (exceptcls). This is equivalent to creating anclick.Optioninstance manually and attaching it to theclick.Command.paramslist.New in version 0.7.0.
- Parameters
cls – the option class to instantiate. This defaults to
click.Option.- Return type
-
colour_option(help_text='Whether to use coloured output.')[source] Adds an option (via the parameter
colour:bool) to enable verbose output.New in version 0.4.0.
-
flag_option(*args, default=False, **kwargs)[source] Decorator to a flag option to a click command.
New in version 0.7.0.
- Parameters
*args – Positional arguments passed to
click.option().default (
Optional[bool]) – The default state of the flag. DefaultFalse.**kwargs – Keyword arguments passed to
click.option().
- Return type
-
force_option(help_text)[source] Decorator to add the
-f / --forceoption to a click command.The value is exposed via the parameter
force:bool.New in version 0.5.0.
-
no_pager_option(help_text='Disable the output pager.')[source] Decorator to add the
--no-pageroption to a click command.The value is exposed via the parameter
no_pager:bool.New in version 0.5.0.
-
verbose_option(help_text='Show verbose output.')[source] Adds an option (via the parameter
verbose:int) to enable verbose output.The option can be provided multiple times by the user.
New in version 0.4.0.
-
version_option(callback)[source] Adds an option to show the version and exit.
The option can be provided multiple times by the user. The count is stored as an integer and passed as the third parameter to the callback function.
New in version 0.4.0.
- Parameters
callback (
Callable[[Context,Option,int],Any]) – The callback to invoke when the option is provided.
The callback function might look like:
def version_callback(ctx: click.Context, param: click.Option, value: int): if not value or ctx.resilient_parsing: return if value > 1: click.echo(f"consolekit version {__version__}, Python {sys.version}") else: click.echo(f"consolekit version {__version__}") ctx.exit()