在Python Click中更好地使用`make_pass_decorator`

问题描述 投票：7回答：2

我正在寻找一些建议，以避免必须实例化一个类两次；这更多是一个设计模式问题。我正在使用Python Click库创建应用程序。

我有一个Settings类，它首先将所有初始默认设置加载到词典中（硬编码到应用程序中），然后将用户计算机上TOML文件中的所有设置替代（如果指定）加载到词典中，然后然后最后将两者合并，并使其可用作类实例（settings.<something>）的属性。

对于大多数这些设置，我also希望能够指定命令行标志。优先级将变为：

  1. 命令行标志。如果未指定，则回退到...
  2. TOML文件中的用户设置。如果未指定，则最后回退到...
  3. 应用默认值

为了获得此结果，我发现在使用Click的装饰器时，我必须执行以下操作：

import click
from myapp import Settings

settings = Settings()
pass_settings = click.make_pass_decorator(Settings, ensure=True)

@click.command()
@click.help_option('-h', '--help')
@click.option(
    '-s', '--disk-size',
    default=settings.instance_disk_size,
    help="Disk size",
    show_default=True,
    type=int
)
@click.option(
    '-t', '--disk-type',
    default=settings.instance_disk_type,
    help="Disk type",
    show_default=True,
    type=click.Choice(['pd-standard', 'pd-ssd'])
)
@pass_settings
def create(settings, disk_size, disk_type):
    print(disk_size)
    print(disk_type)

为什么两次？

  • settings = Settings()行需要为@click.option装饰器提供default值。 default值可以来自用户替代TOML文件（如果存在），也可以来自应用程序默认值。
  • click.make_pass_decorator似乎是交错命令的推荐方法；甚至提到了in their documentation。在函数内部，除了传递的CLI参数外，有时我还需要引用Settings类中的其他属性。

我的问题是，哪个更好？是否可以在其他pass_settings装饰器中使用click.option装饰器？还是我应该完全放弃使用click.make_pass_decorator？

python decorator python-decorators python-click
2个回答
4
投票

解决不希望实例化Settings两次的问题的一种方法是从click.Option继承，并将设置实例插入到上下文直接像：

自定义类别：

def build_settings_option_class(settings_instance):

    def set_default(default_name):

        class Cls(click.Option):
            def __init__(self, *args, **kwargs):
                kwargs['default'] = getattr(settings_instance, default_name)
                super(Cls, self).__init__(*args, **kwargs)

            def handle_parse_result(self, ctx, opts, args):
                obj = ctx.find_object(type(settings_instance))
                if obj is None:
                    ctx.obj = settings_instance

                return super(Cls, self).handle_parse_result(ctx, opts, args)

        return Cls

    return set_default

使用自定义类别：

要使用自定义类，请将cls参数传递给@click.option()装饰器，例如：

# instantiate settings
settings = Settings()

# get the setting option builder
settings_option_cls = build_settings_option_class(settings)

# decorate with an option with an appropraie option name
@click.option("--an_option", cls=settings_option_cls('default_setting_name'))

这是如何工作的？

之所以有用，是因为click是一个设计良好的OO框架。 @click.option()装饰器通常会实例化一个click.Option对象，但允许使用cls参数覆盖此行为。所以这是一个相对从我们自己的类中的click.Option继承并轻松完成所需的方法很容易。

在这种情况下，我们使用几个闭包来捕获Settings实例和参数名称。在返回我们通过click.Option.handle_parse_result()类来允许我们将设置对象插入到上下文中。这使pass_settings装饰器可以在上下文中找到设置，因此不需要创建新实例。

测试代码：

import click

class Settings(object):

    def __init__(self):
        self.instance_disk_size = 100
        self.instance_disk_type = 'pd-ssd'


settings = Settings()
settings_option_cls = build_settings_option_class(settings)
pass_settings = click.make_pass_decorator(Settings)


@click.command()
@click.help_option('-h', '--help')
@click.option(
    '-s', '--disk-size',
    cls=settings_option_cls('instance_disk_size'),
    help="Disk size",
    show_default=True,
    type=int
)
@click.option(
    '-t', '--disk-type',
    cls=settings_option_cls('instance_disk_type'),
    help="Disk type",
    show_default=True,
    type=click.Choice(['pd-standard', 'pd-ssd'])
)
@pass_settings
def create(settings, disk_size, disk_type):
    print(disk_size)
    print(disk_type)


if __name__ == "__main__":
    commands = (
        '-t pd-standard -s 200',
        '-t pd-standard',
        '-s 200',
        '',
        '--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)
            create(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.2 (default, Jul 17 2017, 23:14:31) 
[GCC 5.4.0 20160609]
-----------
> -t pd-standard -s 200
200
pd-standard
-----------
> -t pd-standard
100
pd-standard
-----------
> -s 200
200
pd-ssd
-----------
> 
100
pd-ssd
-----------
> --help
Usage: test.py [OPTIONS]

Options:
  -h, --help                      Show this message and exit.
  -s, --disk-size INTEGER         Disk size  [default: 100]
  -t, --disk-type [pd-standard|pd-ssd]
                                  Disk type  [default: pd-ssd]
0
投票

不同意见

而不是修改单击调用并使用动态类构造，而将默认设置公开为Settings类的类属性。 IE：

@click.option(
    '-t', '--disk-type',
    default=settings.instance_disk_type,
    help="Disk type",
    show_default=True,
    type=click.Choice(['pd-standard', 'pd-ssd'])
)

成为

@click.option(
    '-t', '--disk-type',
    default=Settings.defaults.instance_disk_type,
    help="Disk type",
    show_default=True,
    type=click.Choice(['pd-standard', 'pd-ssd'])
)

这可能更干净，并且比接受的答案中使用类构造方法s更清楚代码的语义（含义）。

事实上，Settings.defaults很可能是Settings的一个实例。实例化两次并不重要，因为这实际上不是问题，而是Settings对象的客户端/消费者代码必须执行实例化。如果在Settings类中完成了此操作，则它仍将是一个干净的API，并且不需要调用方实例化两次。

最新问题
© www.soinside.com 2019 - 2024. All rights reserved.