python点击，使选项值可选

Question

我正在使用Python 2开发一个小型命令行工具，然后单击。我的工具要么需要写一个值，要么读它，要么不改变它。如果我能做到以下几点就好了：

mytool --r0=0xffff.....将值设置r0为0xffff
mytool --r0......................读取值 r0
mytool...... …………不要做任何事情r0

根据文档，这似乎不可能，但我可能错过了。那么有可能还是我必须找到不同的方法？

Answer 1

解决这个问题的一种方法是引入另一个名为 的参数r0_set。然后为了保留所需的命令行，我们可以继承click.Command并重写parse_args以将用户r0=0xffff输入r0_set=0xffff

代码：

class RegisterReaderOption(click.Option):
    """ Mark this option as getting a _set option """
    register_reader = True

class RegisterWriterOption(click.Option):
    """ Fix the help for the _set suffix """
    def get_help_record(self, ctx):
        help = super(RegisterWriterOption, self).get_help_record(ctx)
        return (help[0].replace('_set ', '='),) + help[1:]

class RegisterWriterCommand(click.Command):
    def parse_args(self, ctx, args):
        """ Translate any opt= to opt_set= as needed """
        options = [o for o in ctx.command.params
                   if getattr(o, 'register_reader', None)]
        prefixes = {p for p in sum([o.opts for o in options], [])
                    if p.startswith('--')}
        for i, a in enumerate(args):
            a = a.split('=')
            if a[0] in prefixes and len(a) > 1:
                a[0] += '_set'
                args[i] = '='.join(a)

        return super(RegisterWriterCommand, self).parse_args(ctx, args)

测试代码：

@click.command(cls=RegisterWriterCommand)
@click.option('--r0', cls=RegisterReaderOption, is_flag=True,
              help='Read the r0 value')
@click.option('--r0_set', cls=RegisterWriterOption,
              help='Set the r0 value')
def cli(r0, r0_set):
    click.echo('r0: {}  r0_set: {}'.format(r0, r0_set))

cli(['--r0=0xfff', '--r0'])
cli(['--help'])

结果：

r0: True  r0_set: 0xfff

Usage: test.py [OPTIONS]

Options:
  --r0       Read the r0 value
  --r0=TEXT  Set the r0 value
  --help     Show this message and exit.