如何从Python 3中的现有程序使用argparse创建子解析器？

Question

原始帖子：

如果有一个可执行文件mini_program.py ，它使用具有以下结构的argparse ：

def main():
    parser = argparse.ArgumentParser()
    parser.add_argument('-X', '--attribute_matrix', type=str, help = 'Input: Path/to/Tab-separated-value.tsv')
    parser.add_argument('-y', '--target_vector', type=str, help = 'Input: Path/to/Tab-separated-value.tsv')
    opts = parser.parse_args()

if __name__ == "__main__":
    main()

如何创建一个控制器程序parent_program.py ，该程序使用argparse （我认为与subparser ？）具有与以下类似的用法：

python parent_program.py --help

blah-blah list of programs that can be used

然后使用子程序：

python parent_program.py mini_program --help

-X description
-y description
etc...

所有参数如何从mini_program.py传播到parent_program.py ？

编辑（更具体的错误消息）：

该程序

import argparse
def main():
    parser = argparse.ArgumentParser()
    # Subprograms
    subprograms = parser.add_subparsers(title="subprograms")
    # ============
    # mini-program
    # ============
    parser_miniprogram = subprograms.add_parser("miniprogram")

    # Input
    parser_miniprogram.add_argument('-X', '--attribute_matrix', type=str, help = 'Input: Path/to/Tab-separated-value.tsv')
    parser_miniprogram.add_argument('-y', '--target_vector', type=str, help = 'Input: Path/to/Tab-separated-value.tsv')
    opts = parser.parse_args()
    opts_miniprogram = parser_miniprogram.parse_args()
    print(opts_miniprogram.__dict__)

if __name__ == "__main__":
    main()

检查以确保文档正常工作

# parent program
python parent_program.py --help
usage: parent_program.py [-h] {miniprogram} ...

optional arguments:
  -h, --help     show this help message and exit

subprograms:
  {miniprogram}

# miniprogram
python parent_program.py miniprogram --help
usage: parent_program.py miniprogram [-h] [-X ATTRIBUTE_MATRIX]
                                     [-y TARGET_VECTOR]

optional arguments:
  -h, --help            show this help message and exit
  -X ATTRIBUTE_MATRIX, --attribute_matrix ATTRIBUTE_MATRIX
                        Input: Path/to/Tab-separated-value.tsv
  -y TARGET_VECTOR, --target_vector TARGET_VECTOR
                        Input: Path/to/Tab-separated-value.tsv

尝试运行它：

python parent_program.py miniprogram -X ../../Data/X_iris.noise_100.tsv.gz -y ../../Data/y_iris.tsv
usage: parent_program.py miniprogram [-h] [-X ATTRIBUTE_MATRIX]
                                     [-y TARGET_VECTOR]
parent_program.py miniprogram: error: unrecognized arguments: miniprogram

Answer 1

父程序可能具有如下代码

import mini_program
import sys
<do its own parsing>
if 'use_mini':
    <modify sys.argv>
    mini_program.main()

按照书面规定，导入mini_program不会运行其解析器。 但是调用它的main意愿，但是使用它在sys.argv找到的列表。

父解析器的编写方式应使其接受所需的参数，并且不要阻塞mini想要的输入“ -X”和“ -y”。 然后，将这些“额外”值放入经过修改的sys.argv ， mini解析器可以处理。

parse_known_args是接受未知参数的一种方法， https： parse_known_args

nargs=argparse.REMAINDER ， https: nargs=argparse.REMAINDER ，是另一种收集剩余参数以进行传递的方法。

如果mini main编写为：

def main(argv=None):
    parser = argparse.ArgumentParser()
    parser.add_argument('-X', '--attribute_matrix', type=str, help = 'Input: Path/to/Tab-separated-value.tsv')
    parser.add_argument('-y', '--target_vector', type=str, help = 'Input: Path/to/Tab-separated-value.tsv')
    opts = parser.parse_args(argv)

可以用

mini_program.main(['-X', 'astring','-y','another'])

也就是说，使用显式的argv列表，而不是通过sys.argv进行工作。

阻止主解析器响应“ -h”帮助可能很棘手。 subparsers可能是最干净的方法。

您可以将子解析器与mini main的调用结合使用。 我现在不会尝试得出这些细节。

定义main另一种方法是：

def main():
    parser = argparse.ArgumentParser()
    parser.add_argument('-X', '--attribute_matrix', type=str, help = 'Input: Path/to/Tab-separated-value.tsv')
    parser.add_argument('-y', '--target_vector', type=str, help = 'Input: Path/to/Tab-separated-value.tsv')
    return parser

并用作

 opts = main().parse_args()
 opts = mini_program.main().parse_args()

换句话说，使用main来定义解析器，但是会延迟解析。

Answer 2

我的实际解决方案是对以上内容的适应：

# Controller
def main(argv=None):
    parser = argparse.ArgumentParser(prog="parent_program", add_help=True)
    parser.add_argument("subprogram")
    opts = parser.parse_args(argv)
    return opts.subprogram


# Initialize
if __name__ == "__main__":
    # Get the subprogram 
    subprogram = main([sys.argv[1]])
    module = importlib.import_module(subprogram)
    module.main(sys.argv[2:])