一起使用多个选项或根本不使用
Use several options together or not at all
正如标题所说，我想同时使用几个选项，或者根本不使用，但是我的方法看起来比较丑陋，我想知道是否有更简洁的方法来实现这一点。此外，我还查看了 ，关于如何在 argparse 中完成它，但如果可能的话，我想在 click 中实现它（我试图避免使用 nargs=[...]).
到目前为止，这是我拥有的：
@click.group(invoke_without_command=True, no_args_is_help=True)
@click.option(
"-d",
"--group-dir",
type=click.Path(),
default="default",
help='the directory to find the TOML file from which to run multiple jobs at the same time; defaults to the configuration directory of melmetal: "~/.melmetal" on Unix systems, and "C:\Users\user\.melmetal" on Windows',
)
@click.option("-f", "--group-file", help="the TOML file name")
@click.option(
"-n", "--group-name", help="name of the group of jobs"
)
@click.option(
"--no-debug",
is_flag=True,
type=bool,
help="prevent logging from being output to the terminal",
)
@click.pass_context
@logger.catch
def main(ctx, group_dir, group_file, group_name, no_debug):
options = [group_file, group_name]
group_dir = False if not any(options) else group_dir
options.append(group_dir)
if not any(options):
pass
elif not all(options):
logger.error(
colorize("red", "Sorry; you must use all options at once.")
)
exit(1)
else:
[...]
还有第二个例子：
if any(createStuff):
if not all(createStuff):
le(
colorize("red", 'Sorry; you must use both the "--config-dir" and "--config-file" options at once.')
)
exit(1)
elif any(filtered):
if len(filtered) is not len(drbc):
le(
colorize("red", 'Sorry; you must use all of "--device", "--repo-name", "--backup-type", and "--config-dir" at once.')
)
exit(1)
else:
ctx = click.get_current_context()
click.echo(ctx.get_help())
exit(0)
如何在未提供 sub-commands 时显示帮助文本？据我了解，这应该是自动发生的，但对于我的代码，它会自动转到主要功能。我的解决方法的一个例子是在第二个例子中，即在 else 语句下。
您可以通过构建派生自 click.Option 的自定义 class 强制使用组中的所有选项，并在其中 class 覆盖 click.Option.handle_parse_result() 方法，例如：
自定义选项 Class:
import click
class GroupedOptions(click.Option):
def __init__(self, *args, **kwargs):
self.opt_group = kwargs.pop('opt_group')
assert self.opt_group, "'opt_group' parameter required"
super(GroupedOptions, self).__init__(*args, **kwargs)
def handle_parse_result(self, ctx, opts, args):
if self.name in opts:
opts_in_group = [param.name for param in ctx.command.params
if isinstance(param, GroupedOptions) and
param.opt_group == self.opt_group]
missing_specified = tuple(name for name in opts_in_group
if name not in opts)
if missing_specified:
raise click.UsageError(
"Illegal usage: When using option '{}' must also use "
"all of options {}".format(self.name, missing_specified)
)
return super(GroupedOptions, self).handle_parse_result(
ctx, opts, args)
使用自定义 Class:
要使用自定义 class，请将 cls 参数传递给 click.option 装饰器，例如：
@click.option('--opt1', cls=GroupedOptions, opt_group=1)
另外给一个带有opt_group参数的选项组号。
这是如何工作的？
之所以可行，是因为 click 是一个设计良好的 OO 框架。 @click.option() 装饰器通常实例化一个 click.Option 对象，但允许使用 cls 参数覆盖此行为。因此，在我们自己的 class 中继承 click.Option 并覆盖所需的方法是一件相对容易的事情。
在这种情况下，我们超越 click.Option.handle_parse_result() 并检查是否指定了我们组中的其他选项。
注意：此答案的灵感来自
测试代码：
@click.command()
@click.option('--opt1', cls=GroupedOptions, opt_group=1)
@click.option('--opt2', cls=GroupedOptions, opt_group=1)
@click.option('--opt3', cls=GroupedOptions, opt_group=1)
@click.option('--opt4', cls=GroupedOptions, opt_group=2)
@click.option('--opt5', cls=GroupedOptions, opt_group=2)
def cli(**kwargs):
for arg, value in kwargs.items():
click.echo("{}: {}".format(arg, value))
if __name__ == "__main__":
commands = (
'--opt1=x',
'--opt4=a',
'--opt4=a --opt5=b',
'--opt1=x --opt2=y --opt3=z --opt4=a --opt5=b',
'--help',
'',
)
import sys, time
time.sleep(1)
print('Click Version: {}'.format(click.__version__))
print('Python Version: {}'.format(sys.version))
for cmd in commands:
try:
time.sleep(0.1)
print('-----------')
print('> ' + cmd)
time.sleep(0.1)
cli(cmd.split())
except BaseException as exc:
if str(exc) != '0' and \
not isinstance(exc, (click.ClickException, SystemExit)):
raise
结果：
Click Version: 6.7
Python Version: 3.6.3 (v3.6.3:2c5fed8, Oct 3 2017, 18:11:49) [MSC v.1900 64 bit (AMD64)]
-----------
> --opt1=x
Error: Illegal usage: When using option 'opt1' must also use all of options ('opt2', 'opt3')
-----------
> --opt4=a
Error: Illegal usage: When using option 'opt4' must also use all of options ('opt5',)
-----------
> --opt4=a --opt5=b
opt4: a
opt5: b
opt1: None
opt2: None
opt3: None
-----------
> --opt1=x --opt2=y --opt3=z --opt4=a --opt5=b
opt1: x
opt2: y
opt3: z
opt4: a
opt5: b
-----------
> --help
Usage: test.py [OPTIONS]
Options:
--opt1 TEXT
--opt2 TEXT
--opt3 TEXT
--opt4 TEXT
--opt5 TEXT
--help Show this message and exit.
-----------
>
opt1: None
opt2: None
opt3: None
opt4: None
opt5: None
您可以使用 Cloup。它添加了选项组并允许对任何参数组定义约束。它包含一个 all_or_none 约束，可以完全满足您的需求。
免责声明：我是 Cloup 的作者。
from cloup import command, option, option_group
from cloup.constraints import all_or_none
@command()
@option_group(
'My peculiar options',
option('--opt1'),
option('--opt2'),
option('--opt3'),
constraint=all_or_none,
)
def cmd(**kwargs):
print(kwargs)
求助：
Usage: cmd [OPTIONS]
My peculiar options [provide all or none]:
--opt1 TEXT
--opt2 TEXT
--opt3 TEXT
Other options:
--help Show this message and exit.
错误信息：
Usage: cmd [OPTIONS]
Try 'cmd --help' for help.
Error: either all or none of the following parameters must be set:
--opt1, --opt2, --opt3
这个错误消息可能不是最好的，所以我可能会在下一个版本中更改它。但是你可以很容易地在 Cloup 中很容易地自己做，例如：
provide_all_or_none = all_or_none.rephrased(
error='if you provide one of the following options, you need to provide '
'all the others in the list:\n{param_list}'
)
然后你得到：
Error: if you provide one of the following options, you need to provide all the others in the list:
--opt1, --opt2, --opt3
正如标题所说，我想同时使用几个选项，或者根本不使用，但是我的方法看起来比较丑陋，我想知道是否有更简洁的方法来实现这一点。此外，我还查看了 argparse 中完成它，但如果可能的话，我想在 click 中实现它（我试图避免使用 nargs=[...]).
到目前为止，这是我拥有的：
@click.group(invoke_without_command=True, no_args_is_help=True)
@click.option(
"-d",
"--group-dir",
type=click.Path(),
default="default",
help='the directory to find the TOML file from which to run multiple jobs at the same time; defaults to the configuration directory of melmetal: "~/.melmetal" on Unix systems, and "C:\Users\user\.melmetal" on Windows',
)
@click.option("-f", "--group-file", help="the TOML file name")
@click.option(
"-n", "--group-name", help="name of the group of jobs"
)
@click.option(
"--no-debug",
is_flag=True,
type=bool,
help="prevent logging from being output to the terminal",
)
@click.pass_context
@logger.catch
def main(ctx, group_dir, group_file, group_name, no_debug):
options = [group_file, group_name]
group_dir = False if not any(options) else group_dir
options.append(group_dir)
if not any(options):
pass
elif not all(options):
logger.error(
colorize("red", "Sorry; you must use all options at once.")
)
exit(1)
else:
[...]
还有第二个例子：
if any(createStuff):
if not all(createStuff):
le(
colorize("red", 'Sorry; you must use both the "--config-dir" and "--config-file" options at once.')
)
exit(1)
elif any(filtered):
if len(filtered) is not len(drbc):
le(
colorize("red", 'Sorry; you must use all of "--device", "--repo-name", "--backup-type", and "--config-dir" at once.')
)
exit(1)
else:
ctx = click.get_current_context()
click.echo(ctx.get_help())
exit(0)
如何在未提供 sub-commands 时显示帮助文本？据我了解，这应该是自动发生的，但对于我的代码，它会自动转到主要功能。我的解决方法的一个例子是在第二个例子中，即在 else 语句下。
您可以通过构建派生自 click.Option 的自定义 class 强制使用组中的所有选项，并在其中 class 覆盖 click.Option.handle_parse_result() 方法，例如：
自定义选项 Class:
import click
class GroupedOptions(click.Option):
def __init__(self, *args, **kwargs):
self.opt_group = kwargs.pop('opt_group')
assert self.opt_group, "'opt_group' parameter required"
super(GroupedOptions, self).__init__(*args, **kwargs)
def handle_parse_result(self, ctx, opts, args):
if self.name in opts:
opts_in_group = [param.name for param in ctx.command.params
if isinstance(param, GroupedOptions) and
param.opt_group == self.opt_group]
missing_specified = tuple(name for name in opts_in_group
if name not in opts)
if missing_specified:
raise click.UsageError(
"Illegal usage: When using option '{}' must also use "
"all of options {}".format(self.name, missing_specified)
)
return super(GroupedOptions, self).handle_parse_result(
ctx, opts, args)
使用自定义 Class:
要使用自定义 class，请将 cls 参数传递给 click.option 装饰器，例如：
@click.option('--opt1', cls=GroupedOptions, opt_group=1)
另外给一个带有opt_group参数的选项组号。
这是如何工作的？
之所以可行，是因为 click 是一个设计良好的 OO 框架。 @click.option() 装饰器通常实例化一个 click.Option 对象，但允许使用 cls 参数覆盖此行为。因此，在我们自己的 class 中继承 click.Option 并覆盖所需的方法是一件相对容易的事情。
在这种情况下，我们超越 click.Option.handle_parse_result() 并检查是否指定了我们组中的其他选项。
注意：此答案的灵感来自
测试代码：
@click.command()
@click.option('--opt1', cls=GroupedOptions, opt_group=1)
@click.option('--opt2', cls=GroupedOptions, opt_group=1)
@click.option('--opt3', cls=GroupedOptions, opt_group=1)
@click.option('--opt4', cls=GroupedOptions, opt_group=2)
@click.option('--opt5', cls=GroupedOptions, opt_group=2)
def cli(**kwargs):
for arg, value in kwargs.items():
click.echo("{}: {}".format(arg, value))
if __name__ == "__main__":
commands = (
'--opt1=x',
'--opt4=a',
'--opt4=a --opt5=b',
'--opt1=x --opt2=y --opt3=z --opt4=a --opt5=b',
'--help',
'',
)
import sys, time
time.sleep(1)
print('Click Version: {}'.format(click.__version__))
print('Python Version: {}'.format(sys.version))
for cmd in commands:
try:
time.sleep(0.1)
print('-----------')
print('> ' + cmd)
time.sleep(0.1)
cli(cmd.split())
except BaseException as exc:
if str(exc) != '0' and \
not isinstance(exc, (click.ClickException, SystemExit)):
raise
结果：
Click Version: 6.7
Python Version: 3.6.3 (v3.6.3:2c5fed8, Oct 3 2017, 18:11:49) [MSC v.1900 64 bit (AMD64)]
-----------
> --opt1=x
Error: Illegal usage: When using option 'opt1' must also use all of options ('opt2', 'opt3')
-----------
> --opt4=a
Error: Illegal usage: When using option 'opt4' must also use all of options ('opt5',)
-----------
> --opt4=a --opt5=b
opt4: a
opt5: b
opt1: None
opt2: None
opt3: None
-----------
> --opt1=x --opt2=y --opt3=z --opt4=a --opt5=b
opt1: x
opt2: y
opt3: z
opt4: a
opt5: b
-----------
> --help
Usage: test.py [OPTIONS]
Options:
--opt1 TEXT
--opt2 TEXT
--opt3 TEXT
--opt4 TEXT
--opt5 TEXT
--help Show this message and exit.
-----------
>
opt1: None
opt2: None
opt3: None
opt4: None
opt5: None
您可以使用 Cloup。它添加了选项组并允许对任何参数组定义约束。它包含一个 all_or_none 约束，可以完全满足您的需求。
免责声明：我是 Cloup 的作者。
from cloup import command, option, option_group
from cloup.constraints import all_or_none
@command()
@option_group(
'My peculiar options',
option('--opt1'),
option('--opt2'),
option('--opt3'),
constraint=all_or_none,
)
def cmd(**kwargs):
print(kwargs)
求助：
Usage: cmd [OPTIONS]
My peculiar options [provide all or none]:
--opt1 TEXT
--opt2 TEXT
--opt3 TEXT
Other options:
--help Show this message and exit.
错误信息：
Usage: cmd [OPTIONS]
Try 'cmd --help' for help.
Error: either all or none of the following parameters must be set:
--opt1, --opt2, --opt3
这个错误消息可能不是最好的，所以我可能会在下一个版本中更改它。但是你可以很容易地在 Cloup 中很容易地自己做，例如：
provide_all_or_none = all_or_none.rephrased(
error='if you provide one of the following options, you need to provide '
'all the others in the list:\n{param_list}'
)
然后你得到：
Error: if you provide one of the following options, you need to provide all the others in the list:
--opt1, --opt2, --opt3