如何使用 click 来解析参数的字符串?

rub*_*dub 5 python argparse python-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)
Run Code Online (Sandbox Code Playgroud)

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

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

对于更广泛的上下文,这个问题是构建了一个启动器应用程序的结果,最终用户将其用作启动他们自己的应用程序的脚手架。在这里,启动器使用了许多参数,点击装饰器可以完美地使用这些参数。可以按照此处的文档中所示处理未知参数。然后,该启动器使用这些未解析的参数调用提供可调用的最终用户。Click 将未解析的参数作为字符串元组。在这种情况下,最终用户如何能够使用 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()
Run Code Online (Sandbox Code Playgroud)

从命令行运行:

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

rub*_*dub 0

查看评论和随后的编辑,让我认为简单地将单击装饰器应用于子函数可能会起作用。确实如此,但我不完全知道为什么。

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)

@click.command()
@click.option('--prog-arg')
def child_function(prog_arg: str) -> None:
    # How do I get Click to parse the provided args for me?
    print(f"Child function passed: {prog_arg}")

if __name__ == "__main__":
    # pylint: disable=no-value-for-parameter, unexpected-keyword-arg
    main()
Run Code Online (Sandbox Code Playgroud)
python3 so_test.py --uri test.com --prog-arg 10
Was passed a URI of test.com
Additional args are ('--prog-arg', '10')
Child function passed: 10
Run Code Online (Sandbox Code Playgroud)