【发布时间】：2012-10-26 06:08:12
【问题描述】：
tldnr：给定一个函数，有没有办法根据其签名自动创建 ArgumentParser？
我有一堆函数想要在命令行中公开。所以基本上，一个模块：
def copy(foo, bar, baz):
...
def move(from, to):
...
def unlink(parrot, nomore=True):
...
if __name__ == '__main__':
argparse stuff
可以像这样从命令行调用：
python commands.py move spam ham
python commands.py unlink --parrot Polly
虽然这很容易实现，但涉及到很多布线：
parser = argparse.ArgumentParser(...)
subparsers = parser.add_subparsers()
...
c = subparsers.add_parser('unlink', description='Unlink a parrot')
c.add_argument('--parrot', help='parrots name', required=True)
c.add_argument('--nomore', help='this parrot is no more', action='store_true')
...
c = subparsers.add_parser('move', description='Move stuff')
...
等等，对于每个函数。最糟糕的是，如果函数参数发生变化（并且确实发生了变化），argparse 的内容需要手动同步。
如果函数可以为自己提供 argparse 的东西会更好，这样主代码就会像这样：
parser = argparse.ArgumentParser(...)
subparsers = parser.add_subparsers()
copy.register(subparsers)
move.register(subparsers)
unlink.register(subparsers)
...
我想到了以下几点：
@args(
description='Unlink a parrot',
parrot={'required':True, 'help':'parrots name'},
nomore={'action': 'store_true', 'help': 'this parrot is no more'}
)
def unlink(parrot, nomore=True):
...
我的问题：
- 有没有这样的库？
- 如果没有，是否可以编写这样的装饰器，如何编写？
- 还有其他/更好的方法来实现我想要的吗？
更新：
plac 似乎是解决方案。下面是如何用 plac 做我想做的事：
命令模块：cmds.py：
import plac
@plac.annotations(
foo=('the foo thing'),
bar=('the bar thing'),
fast=('do a fast copy', 'flag')
)
def copy(foo, bar, fast=False):
"""Copy some foo to bar."""
pass
@plac.annotations(
parrots=('parrots names'),
nomore=('these parrots are no more', 'flag'),
repeat=('repeat n times', 'option', 'r', int)
)
def unlink(nomore=False, repeat=1, *parrots):
"""Unlink some parrots."""
pass
#more commands...
# export commands so that plac knows about them
commands = 'copy', 'unlink'
这是主模块：
import plac
import cmds
plac.call(cmds)
如果你问我，那就太好了。
【问题讨论】：
-
您可能必须在函数中添加注释。那么应该可以编写一个给定函数注释的函数返回该函数的解析器。