从外部模块添加argparse参数

时间:2014-05-25 01:39:07

标签: python argparse

我试图编写一个可以由第三方扩展的Python程序。程序将从命令行运行,并提供任何参数。

为了让第三方创建自己的模块,我创建了以下(简化)基类:

class MyBaseClass(object):
    def __init__(self):
        self.description = ''
        self.command = ''

    def get_args(self):
        # code that I can't figure out to specify argparse arguments here
        # args = []
        # arg.append(.....)
        return args

它们通过get_args()提供的任何参数都将添加到该特定模块的subparser中。我希望他们能够指定任何类型的参数。

我不确定声明然后从子类模块到我的主程序的参数的最佳方法。我成功找到MyBaseClass的所有子类并循环遍历它们以创建子分析器,但我找不到一种干净的方法来将各个参数添加到subparser。

以下是主程序的当前代码:

for module in find_modules():
    m = module()
    subparser_dict[module.__name__] = subparsers.add_parser(m.command, help=m.help)
    for arg in m.get_args():
            subparser_dict[module.__name__].add_argument(...)

如何通过get_args()或类似方法最好地指定外部模块中的参数,然后将它们添加到subparser?我失败的尝试之一看起来像下面这样,因为它试图将所有可能的选项传递给add_argument(),无论它是否具有值或是否为:

            subparser_dict[module.__name__].add_argument(arg['long-arg'],
                action=arg['action'],
                nargs=arg['nargs'],
                const=arg['const'],
                default=arg['default'],
                type=arg['type'],
                choices=arg['choices'],
                required=arg['required'],
                help=arg['help'],
                metavar=arg['metavar'],
                dest=arg['dest'],
                )

2 个答案:

答案 0 :(得分:3)

如果不想完全理解您的模块结构,我想您希望能够将add_argument调用的参数作为可以导入的对象提供。

例如,您可以提供位置参数列表和关键字参数字典:

args=['-f','--foo']
kwargs={'type':int, 'nargs':'*', 'help':'this is a help line'}

parser=argparse.ArgumentParser()
parser.add_argument(*args, **kwargs)
parser.print_help()
制造

usage: ipython [-h] [-f [FOO [FOO ...]]]

optional arguments:
  -h, --help            show this help message and exit
  -f [FOO [FOO ...]], --foo [FOO [FOO ...]]
                        this is a help line

argparse.py中,add_argument方法(超级ArgumentParser)的方法具有此一般签名

def add_argument(self, *args, **kwargs):

此方法的代码操纵这些参数,将args添加到kwargs,添加默认值,最后将kwargs传递给相应的Action类,返回新的行动。 (它还注册'与解析器或子解析器的操作)。它是列出参数及其默认值的Action子类的__init__

答案 1 :(得分:2)

我只会从您的ArgumentParser方法返回get_args个实例。然后,您可以使用ArgumentParser参数创建新的parents以加入所有其他参数解析器:https://docs.python.org/3/library/argparse.html#parents