Python单击“库重命名参数”

时间:2016-02-23 02:36:04

标签: python python-click

我正在使用Click库,但我似乎找不到与dest argparse类似的行为。

例如,我有

@click.option('--format', type=click.Choice(['t', 'j']))
def plug(format):
  pass

请注意,我正在使用带有--format的标记,该标记会被转换为内置的Python构造format,这是不理想的。

有没有办法更改传递给选项的click函数的参数?

2 个答案:

答案 0 :(得分:8)

虽然Click没有dest - 相当于argparse,但它具有某些可被利用的参数命名行为。具体来说,对于具有多个可能名称的参数,它将更喜欢非虚线到虚线名称,并且作为辅助首选项将优先考虑较长名称而不是较短名称。

网址:http://click.pocoo.org/dev/parameters/#parameter-names

因此,如果您将选项声明为......

@click.option('--format', 'not-format', type=click.Choice(['t', 'j']))

...然后点击将优先处理非虚线变体('not-format')并使用not_format=...参数调用您的函数。

当然这也意味着这种替代拼写也可以在命令行中使用。如果不需要,那么我想你可以添加一个装饰器来重命名关键字参数:

import functools

def rename_kwargs(**replacements):
    def actual_decorator(func):
        @functools.wraps(func)
        def decorated_func(*args, **kwargs):
            for internal_arg, external_arg in replacements.iteritems():
                if external_arg in kwargs:
                    kwargs[internal_arg] = kwargs.pop(external_arg)
            return func(*args, **kwargs)
        return decorated_func
    return actual_decorator

测试代码:

if __name__ == '__main__':

    @rename_kwargs(different_arg='format')
    def tester(different_arg):
        print different_arg

    tester(format='test value')

测试输出:

$ python test_decor.py
test value

在您的情况下,它看起来像:

@click.option('--format', type=click.Choice(['t', 'j']))
@replace_kwargs(not_format='format')
def plug(not_format):
    pass

答案 1 :(得分:6)

如果用

装饰你的方法
@click.option('--format', '-f', 'format_arg_name')
def plug(format_arg_name):
    print(format_arg_name)

然后它会将选项映射到format_arg_name参数。

format_arg_name将无法在命令行中使用。