一个命令行参数的“the”可以依赖于另一个参数的值吗？

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)

我不想对parser.parse_args()进行后置处理，因为我正在编写大量的脚本，所有这些脚本都需要这种输入样式，除了一些脚本可能会对'input'参数采取不同的方式(例如，其中一个可能使用两个这样的参数，一个可能是input1 3 4 randomInfo input2，或者--first input1 --second input2等等)。这意味着，如果我在后置处理中这样做，一般不知道应该解析哪些参数：

# 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过滤掉一些数据)。

总结：

根据Value

• I不想通过后置处理parse_args()来处理这个不同的解析，
• 给定--type Value，input应该进行不同的解析，因为这需要了解特定脚本的参数，而这些参数是我在“库”中所没有的。
• 我正在编写大量密切相关的脚本，它们都需要这个接口，这就是为什么我想抽象出一个通用的parse_args(parser)或类似的函数。

F 221

Answer 1

在这方面使用type是有问题的。至少很难理解，而且效率也很低。script --input input --help将使用parse_input函数解析input，然后argparse才会意识到存在一个--help，它应该只打印帮助消息并退出。

这不太好，但是您仍然可以使用一个自定义parse_args(...)函数来获得这种行为，该函数添加了库标志，但也接受了要使用parse_input作为参数的名称。这还有一个额外的好处，即在错误处理方面具有更大的灵活性：

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'，但是代码要容易得多；没有全局或类似的代码。

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

如果您知道input在创建parser时依赖于type，那么您也可以在紧接之后知道这一点。

了解您的load函数的作用，可能会给您带来更多的洞察力。期望type函数将执行简单的转换，或者在发生错误时引发错误(TypeError、ValueError或argparse.ArgumentTypeError)。argparse.FileType可能是argparse开发人员考虑过的最精细的类型可调用类型，即使是这种类型也不成熟。它所做的就是打开一个文件，但现在我们被鼓励在with上下文中打开文件，以确保迅速关闭。

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

无论如何，调用type时只有一个参数，即字符串。它当时无法访问解析器内部正在进行的任何其他操作，甚至连args名称空间也不能访问。argparse的基本原理是按照用户提供的顺序解析参数。位置显然是顺序依赖的，但是标记的位置(optionals)是顺序无关的，因此实现相互依赖是很困难的。具有multually_exlusive依赖关系的xor是它得到的最精细的部分。

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

双解析确实有其用途。例如，我编写了parser.parse_intermixed_args方法，以便在混合位置和选项时提供更大的灵活性。您可以自由地学习argparse.py文件。

Answer 3

您可以通过两次解析参数并设置全局参数来获得此行为：

# 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)