一个命令行参数 `type` 是否可以依赖于带有 argparse 的另一个参数的值？

Question

我正在编写一组 python 脚本，可以解析多种输入格式，但这些输入的 type 由另一个命令行参数决定。如何让一个参数影响另一个参数的类型？

展示我想要的行为的示例：

import argparse

def load_single_file(filepath: str):
    ...

def load_directory(filepath: str):
    ...

parser = argparse.ArgumentParser()
parser.add_argument('--type', choices=('single-file', 'directory'), required=True)
parser.add_argument('input', type=load_single_file if '--type' == 'single-file' else load_directory)

我不想 post-process parser.parse_args() 因为我正在编写大量脚本，所有这些都需要这种输入样式，除了其中一些可能需要他们的'input' 参数不同（例如，一个可能采用两个这样的参数，一个可能是 input1 3 4 randomInfo input2，或 --first input1 --second input2，等等）这意味着我通常不知道应该解析哪些参数，如果我在 post-processing:

中这样做

# This doesn't work:
def parse_args(parser):
    parser.add_argument('--type', choices=('single-file', 'directory'), required=True)
    args = parser.parse_args()

    parser = load_single_file if args.type== 'single-file' else load_directory
    # Which elements of `args` should have `parser` applied to it? It's impossible to tell.
    # I cannot just specify `'input'` here too, as some scripts may want multiple or interspersed inputs.

我可以将这种行为收集到一个函数中，这对我来说也很重要，因为我有几个参数（不仅仅是 --type）会影响解析数据的方式（例如 --filter过滤掉一些数据）

总结：

给定 --type Value，input 应该根据 Value
我不想通过 post-processing parse_args() 来处理这种不同的解析，因为这需要了解特定脚本的参数，而我的“图书馆。
我正在编写大量密切相关的脚本，都需要这个接口，这就是为什么我想抽象出一个通用的parse_args(parser)或类似的功能。

Answer 1

您可以通过两次解析参数并设置全局变量来实现此行为：

# Use for type=parse_input
def parse_input(str, parse_fn=None):
    if parse_fn is None:
        parse_fn = parse_input.parse_fn

    return parse_fn(str)

def parse_args(parser):
    def add_args(parser, required):
        parser.add_argument('--type', choices=('single-file', 'directory'), required=required)

    # No --help, because we want to get the --help for `parser` if so
    initial_parser = argparse.ArgumentParser(add_help=False)
    # Any required arguments should be set to False so that we can get the message from `parser`
    add_args(initial_parser, required=False)
    first, rest = initial_parser.parse_known_args()

    # Note: if you use prefix_chars, these won't necessarily be `-h` and `--help`.
    # Use:
    # if '-' in parser.prefix_chars:
    #     p = '-'
    # else:
    #     p = parser.prefix_chars[0]
    # And:
    #   f'{p}h', f'{p}{p}help'
    if all(h not in rest for h in ('-h', '--help')):
        parse_input.parse_fn = load_single_file if first.type== 'single-file' else load_directory
    else:
        # Allow better error message if parse_fn is missing
        parse_input.parse_fn = lambda s: s

    add_args(parser, required=True)
    return parser.parse_args()

用法：

parser = argparse.ArgumentParser()
parser.add_argument('input', type=parse_input)
...

args = parse_args(parser)

Answer 2

我不明白有什么问题:

 def parse_args():
      parser = argparse.ArgumentParser()
      parser.add_argument('--type', choices=('single-file', 'directory'), required=True)
      parser.add_argument('input', type=load_single_file if '--type' == 'single-file' else load_directory)
      args = parser.parse_args()
      # print(args) # for debugging
      foo = load_single_file(args.input) if args.type=='single-file' else load_directory(args.input)
      args.input = foo    # if you want that result back on args
      return args

如果您在创建 parser 时知道 input 依赖于 type，您也会在创建 parser 之后立即知道。

了解您的 load 函数的作用，可能会提供更深入的见解。期望 type 函数将执行简单的转换，或者如果出现错误（TypeError、ValueError 或 argparse.ArgumentTypeError）则引发错误。 argparse.FileType 可能是 argparse 开发人员考虑过的最精细的可调用类型，即使这样也没有很好地老化。它所做的只是打开一个文件，但现在我们鼓励在 with 上下文中打开文件，以确保迅速关闭。

我的代码没有做的一件事是捕获错误（如果有）。它可以包裹在 try/except 中。您甚至可以使用 parser.error(your-message) 以标准格式显示错误（带退出）。

无论如何，type 只用一个参数调用，一个字符串。它无权访问当时解析器内部发生的任何其他事情，甚至 args 命名空间也不行。 argparse 的基本原理是按照用户提供的顺序解析参数。位置显然依赖于顺序，但标记的 (optionals) 与顺序无关，因此实现相互依赖性很尴尬。具有 xor 依赖性的 multually_exlusive 是最精细的。

其他 SO 问题要求提供相互依赖的 required 或 default 属性。答案已经提出双重解析或自定义 Action 类，但在我看来，post-解析总是最简单的。

双重解析确实有其用途。例如，我编写了 parser.parse_intermixed_args 方法以在混合位置和可选时提供更大的灵活性。自己研究 argparse.py 文件吧。

Answer 3

为此使用 type 是有问题的。至少很难理解并且效率低下。 script --input input --help 将使用 parse_input 函数解析 input before argparse 意识到有一个 --help 它应该只是打印帮助信息并退出。

它没有相当好，但是您仍然可以通过添加库标志的自定义 parse_args(...) 函数获得此行为，但也将名称接收到使用 parse_input on 作为参数。这还有一个额外的好处，即在错误处理方面也具有更大的灵活性：

def parse_args(parser, *names):
    parser.add_argument('--type', choices=('single-file', 'directory'), required=True)
    args = parser.parse_args()

    parser = load_single_file if args.type == 'single-file' else load_directory
    args_dict = vars(args)

    for name in names:
        args_dict[name] = parser(args_dict[name])

    return args

用法示例：

parser = argparse.ArgumentParser()
parser.add_argument('input')

args = parse_args(parser, 'input')

它并不完美，因为您必须在额外的位置指定'input'，但代码更容易理解；没有全局变量或类似变量。

一个命令行参数 `type` 是否可以依赖于带有 argparse 的另一个参数的值？

Can one commandline argument's `type` be dependent on the value of another argument with argparse?

python

argparse

python-3.x