Python Argparse:混合父解析器和子解析器

Python Argparse:混合父解析器和子解析器,python,parameter-passing,argparse,Python,Parameter Passing,Argparse,我想写一个简单的工具,它接受任意数量的输入文件,并对每个文件执行一个操作。语法非常简单: mytool operation input1 input2 ... inputN 其中一些操作可能需要额外的参数 mytool operation op_argument input1 input2 ... inputN 除此之外,我希望用户能够指定是否应该就地执行操作,并指定输出的目标目录 mytool -t $TARGET --in-place operation op_argument inp

我想写一个简单的工具,它接受任意数量的输入文件,并对每个文件执行一个操作。语法非常简单:

mytool operation input1 input2 ... inputN
其中一些操作可能需要额外的参数

mytool operation op_argument input1 input2 ... inputN 
除此之外,我希望用户能够指定是否应该就地执行操作,并指定输出的目标目录

mytool -t $TARGET --in-place operation op_argument input1 input2 input3
作为最后一项要求,我希望用户能够在每个操作上获得单独的帮助,以及在整个工具的使用上获得帮助

下面是我为上述工具设计参数解析器的尝试,以及一个最小的、完整的、可验证的示例:

#!/bin/env python

import argparse
from collections import namedtuple

Operations = namedtuple('Ops', 'name, argument, description')
IMPLEMENTED_OPERATIONS = {'echo': Operations('echo',
                                             None,
                                             'Echo inputs'),
                          'fancy': Operations('fancy',
                                              'fancyarg',
                                              'Do fancy stuff')}


if __name__ == "__main__":

    # Parent parser with common stuff.
    parent = argparse.ArgumentParser(add_help=False)
    parent.add_argument('-t', '--target-directory', type=str, default='.',
                        help="An output directory to store output files.")
    parent.add_argument('-i', '--in-place', action='store_true',
                        help="After succesful execution, delete the inputs.")
    # The inputfiles should be the very last positional argument.
    parent.add_argument('inputfiles', nargs='*', type=argparse.FileType('r'),
                        help="A list of input files to operate on.")

    # Top level parser.
    top_description = "This is mytool. It does stuff"
    parser = argparse.ArgumentParser(prog="mytool",
                                     description=top_description,
                                     parents=[parent])

    # Operation parsers.
    subparsers = parser.add_subparsers(help='Sub-command help', dest='chosen_op')

    op_parsers = {}
    for op_name, op in IMPLEMENTED_OPERATIONS.items():
        op_parsers[op_name] = subparsers.add_parser(op_name,
                                                    description=op.description,
                                                    parents=[parent])
        if op.argument is not None:
            op_parsers[op_name].add_argument(op.argument)

    args = parser.parse_args()
    op_args = {}
    for key, subparser in op_parsers.items():
        op_args[key] = subparser.parse_args()


    print(args.chosen_op)
我的问题是位置参数的顺序是错误的。不知何故,我实现这一点的方式使Argparse认为操作(及其op_参数)应该在输入文件之后,这显然不是事实


如何将父位置参数(在我的例子中是inputfiles)作为最后一个位置参数?

对于主解析器,
子parsers
只是另一个位置参数,但具有唯一的
nargs
(“+…”)。因此,它将首先查找
inputfiles
参数,然后将剩余的任何参数分配给
子parser

将位置与次帕瑟混合是很棘手的。最好将
inputfiles
定义为每个子parser的参数

parents
可以很容易地将同一组参数添加到多个子parser中,但是这些参数将首先添加

所以我想你想要:

for op_name, op in IMPLEMENTED_OPERATIONS.items():
        op_parsers[op_name] = subparsers.add_parser(op_name,
                                                    description=op.description,
                                                    parents=[parent])
        if op.argument is not None:
            op_parsers[op_name].add_argument(op.argument)

        op_parsers[op_name].add_argument('inputfiles', nargs='*', type=argparse.FileType('r'),
                        help="A list of input files to operate on.")
至于帮助,通常的行为是为主解析器或每个子解析器获取帮助。将这些组合到一个显示器中一直是几个问题的主题。这是可能的,但并不容易



主解析器按顺序处理输入字符串-标志、位置等。当它处理
子parser
位置时,它将的任务连同所有剩余的命令行字符串一起交给name子parser。然后,子解析器的作用类似于一个新的独立解析器,并将名称空间返回给主解析器以合并到主名称空间中。主解析器不会继续解析命令行。因此,子Parser操作始终是最后一个。

parents=[parent]
最后一次编辑确实有效,但会打开一个新问题。操作本身作为一个输入结束。如果我尝试
mytool echo file.txt
,它会告诉我
参数inputfiles无法打开echo。没有这样的文件或目录
=/(我当然从父级删除了输入文件),我必须查看完整的更正代码
echo
应作为子Parser名称进行处理。