Question

我想制作一个模块，以使构建共享许多选项的单击命令非常简单。这些选项将被提炼成传递给命令的单个对象。作为说明性示例：

from magic import magic_command
import click

@magic_command('Colored')
@click.option('--color')
def cmd(magic, color):
    pass

然后，total命令将具有许多--magic-...选项，这些选项进入传递到magic的{{1}}对象中。我可以使用以下方法实现这一目标：

cmd

但是，将def magic_command(name): def decorator(func): @click.option('--magic-foo') @click.option('--magic-bar') def wrapper(magic_foo, magic_bar, **kwargs): print(f'initializing Magic with {magic_foo} and {magic_bar}') magic = Magic(magic_foo, magic_bar) func(magic, **kwargs) try: wrapper.__click_params__.extend(func.__click_params__) except AttributeError: pass return click.command(f'{name}-Magic')(wrapper) return decorator弄乱似乎并不是特别干净。

问题有点类似于this one，但是这种方法不允许我将许多魔术选项浓缩为一个魔术对象。

要详细说明，我将不得不使用这种方法

__click_params__

但这意味着自定义代码需要知道存在哪些魔术选项以及如何构造魔术。我想可以使用@magic_command('Colored') @click.option('--color') def cmd(magic_foo, magic_bar, color): magic = Magic(magic_foo, magic_bar) pass进行简化，但是-理想情况下，我只想将准备好的**kwargs对象传递给magic。

Answer 1

在装饰器中更改函数的一些“魔术属性”是完全正常的： functools.wraps就是这样做的。因此您可以：

使用http://127.0.0.1:8000/
在@wraps之后使用@click.option
将魔术选项定义为列表，并使用该列表中的值解析args / kwargs。

@wraps

用法：

from functools import wraps, WRAPPER_ASSIGNMENTS

DEFAULT_MAGIC_OPTIONS = ('--magic-foo', '--magic-bar')


def magic_command(name, magic_options=DEFAULT_MAGIC_OPTIONS):
    magic_options = magic_options or []
    magic_kwarg_names = [opt.split('--', 1)[1].replace('-', '_') for opt in magic_options]

    def decorator(func):
        @wraps(func, assigned=WRAPPER_ASSIGNMENTS+('__click_params__', ))
        def wrapper(*args, **kwargs):
            num_used_magic_args = min(len(magic_kwarg_names), len(args))

            magic_args = args[:num_used_magic_args]

            # If you want magic options to be "args only", then:
            # * you can raise TypeError if num_used_magic_args != len(magic_kwarg_names)
            # * you should not calculate `magic_kwargs`
            magic_kwargs = {}
            for kwarg_name in magic_kwarg_names[num_used_magic_args:]:
                if kwarg_name in kwargs:
                    magic_kwargs[kwarg_name] = kwargs.pop(kwarg_name)

            print(f'Initializing Magic with args={magic_args}, kwargs={magic_kwargs}')
            magic = Magic(*magic_args, **magic_kwargs)
            return func(magic, *args[num_used_magic_args:], **kwargs)

        for magic_option in magic_options[::-1]:  # Reverse order, to have proper positional arguments
            wrapper = click.option(magic_option)(wrapper)

        return click.command(f'{name}-Magic')(wrapper)

    return decorator

Answer 2

我不知道是否可以在不使用单击内部控件的情况下做您想做的事情，但是必须有一种方法，对吧？

无论如何，这是一个使用另一个装饰器的解决方案。这是放在函数的上方，其功能是对magic_*参数进行分组。

def magic_command(f):
    f = click.option('--magic-bar')(f)
    f = click.option('--magic-foo')(f)
    f = click.command()(f)
    return f

def group_magic_args(f):
    def new_f(magic_foo, magic_bar, *args, **kwargs):
        magic = Magic(magic_foo, magic_bar)
        f(magic=magic, *args, **kwargs)
    return new_f

您将像这样使用新的装饰器：

@magic_command
@click.option('--color')
@group_magic_args
def cmd(magic, color):
    pass

Answer 3

您可以很容易地通过构造如下装饰器将多个选项提取到单个对象中：

代码：

def magic_options(func):
    @click.option('--magic-bar')
    @click.option('--magic-foo')
    def distill_magic(magic_foo, magic_bar, **kwargs):
        kwargs['magic'] = Magic(magic_foo, magic_bar)
        func(**kwargs)

    return distill_magic

使用装饰器

然后可以将装饰器应用于命令功能，例如：

@click.command('Colored-Magic')
@click.option('--color')
@magic_options
def cli(magic, color):
    ...

它需要应用于裸函数。这是因为click.option返回的函数已被click框架修改，并且无法按预期方式工作。

测试代码：

import click

@click.command('Colored-Magic')
@click.option('--color')
@magic_options
def cli(magic, color):
    click.echo(str(magic))
    click.echo(color)


class Magic(object):
    def __init__(self, magic_foo, magic_bar):
        self.magic_foo = magic_foo
        self.magic_bar = magic_bar

    def __str__(self):
        return "foo: {}  bar: {}".format(self.magic_foo, self.magic_bar)


if __name__ == "__main__":
    commands = (
        '--magic-foo fooby --magic-bar barbecue',
        '--magic-foo fooby',
        '--magic-bar barbecue',
        '',
        '--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)]
-----------
> --magic-foo fooby --magic-bar barbecue
foo: fooby  bar: barbecue

-----------
> --magic-foo fooby
foo: fooby  bar: None

-----------
> --magic-bar barbecue
foo: None  bar: barbecue

-----------
> 
foo: None  bar: None

-----------
> --help
Usage: test.py [OPTIONS]

Options:
  --color TEXT
  --magic-bar TEXT
  --magic-foo TEXT
  --help            Show this message and exit.

使用自定义装饰器将具有多个常用选项的命令放入一个参数

3 个答案:

代码：

使用装饰器

测试代码：

结果：