首页 > 解决方案 > 如何使用 click 解析参数的字符串?

问题描述

假设我有一个包含参数和选项的字符串列表,使用argparse,我可以使用该parse_args函数将此列表解析为一个对象,如下所示:

import argparse

extra_params = [‘—sum’, ‘7’, ‘-1’, ‘42’]

parser=argparse.ArgumentParser(description=“argparse docs example”)
parser.add_argument(‘integers’, metavar=‘N’, type=int, nargs=‘+’,
                    help=‘an integer for the accumulator’)
parser.add_argument(‘—sum’, dest=‘accumulate’, action=‘store_const’,
                    const=sum, default=max,
                    help=‘sum the integers (default: find the max)’)
parsed_object=parser.parse_args(extra_params)

在这里,argparse已经解析了提供的字符串迭代。还可以click用来解析提供的可迭代字符串吗?

我已经搜索了 API 文档,click似乎parse_args在一组类中有一个函数*Command,但在文档中没有看到关于我如何做到这一点的任何内容。我已经尝试过实例化BaseCommandCommand但不确定如何parse_args在没有正确上下文的情况下开始工作。

对于更广泛的背景,这个问题是构建了一个启动器应用程序的结果,最终用户将其用作脚手架来启动他们自己的应用程序。在这里,启动器使用了许多点击装饰器完美工作的参数。可以按照此处的文档中所示处理未知参数。然后,此启动器使用这些未解析的参数调用最终用户提供的可调用对象。单击将未解析的参数保留为字符串元组。在这种情况下,最终用户如何能够使用 Click 来解析他们感兴趣的参数?这里有一个片段来说明这个问题:

import click
from typing import Tuple

@click.command(name="TestLauncher", context_settings={
  "ignore_unknown_options": True
})
@click.option('--uri', '-u',
  help="URI for the server")
@click.argument('unprocessed_args', nargs=-1,
  type=click.UNPROCESSED)
def main(uri: str, unprocessed_args: Tuple[str, ...]) -> None:
    print(f"Was passed a URI of {uri}")
    print(f"Additional args are {unprocessed_args}")

    child_function(unprocessed_args)

def child_function(unprocessed_args: Tuple[str, ...]) -> None:
    # How do I get Click to parse the provided args for me?
    pass

if __name__ == "__main__":
    # pylint: disable=no-value-for-parameter, unexpected-keyword-arg
    main()

从命令行运行它:

python3 so_test.py --uri test.com --prog-arg 10
Was passed a URI of test.com
Additional args are ('--prog-arg', '10')

标签: pythonargparsepython-click

解决方案


尝试这样的事情:

import click

@click.command()
@click.option('--count', default=1, help='number of greetings')
@click.option('--test', default='test_was_not_provided', help='test option')
@click.argument('name')
def hello(*args, **kwargs):
    click.echo(f"Hello World! {kwargs['name']} {kwargs['count']}")


if __name__ == '__main__':
    hello()

运行类似:python main.py haha --test this_is_a_test --count=40


推荐阅读