我正在处理一个简单的Git / Redmine粘贴脚本,但是我在Python argparse
模块中使用可选参数时遇到了一些困难。
使用以下代码:
import argparse
class MyClass:
def StartWork(self, issueNumber, **kwargs):
if issueNumber is None:
issueNumber = input("please enter an issue number: ")
else:
print("issue number detected")
print(issueNumber)
parser = argparse.ArgumentParser()
subparsers = parser.add_subparsers(dest='MyClass-command', help='Command to perform')
subparsers.required = True
startWorkParser = subparsers.add_parser('startwork', help='Command to begin work on a new branch')
startWorkParser.add_argument("issuenumber", type=int, help="The issue number used to create a local branch based on the specified issue number", nargs='?', default=None)
startWorkParser.set_defaults(func=MyClass.StartWork)
# Parse the arguments to make sure we have all the information requried to actually do something.
args = parser.parse_args()
mc = MyClass()
try:
args.func(mc, **vars(args))
except AssertionError as e:
print("Error: "+str(e))
# Parse the arguments to make sure we have all the information required to actually do something.
args = parser.parse_args()
我期待这样的电话:
python MyClass.py startwork
...导致提示用户输入问题编号。相反,我得到:
Traceback (most recent call last):
File "C:\Projects\RedmnieGlue\MyClass.py", line 23, in <module>
args.func(mc, **vars(args))
TypeError: StartWork() missing 1 required positional argument: 'issueNumber'
那么为什么nargs='?'
不在这里?
修改
如果我这样称呼它:
python MyClass.py startwork -h
我明白了:
usage: class1.py startwork [-h] [issuenumber]
positional arguments:
issuenumber The issue number used to create a local branch based on the
specified issue number
optional arguments:
-h, --help show this help message and exit
...(基于[]
周围的issuenumber
)向我建议 理解这是一个可选参数但有些东西阻止它像我一样工作#39; d期待它。可能与我使用subparsers
和使用arg解析器调用方法有什么关系?
答案 0 :(得分:2)
如果您在函数调用之前打印vars(args)
的内容,请执行以下操作:
print(vars(args))
args.func(mc, **vars(args))
然后您可以轻松验证参数解析器是否有问题。通过调用不带参数的脚本(例如python myscript.py
),您将获得以下输出:
{'MyClass-command': 'startwork', 'issuenumber': None, 'func': <function MyClass.StartWork at 0x000000493898C510>}
正如您所看到的,issuenumber
实际上在该字典中,并且它确实获得了默认值。所以你看到的错误不是因为参数解析器(它也不是一个argparse错误,所以对issuenumber
的参数进行验证是绝对正确的。)
相反,出现问题的是,在使用issuenumber
时,参数**vars(args)
未传递给位置参数。没有发生的原因实际上非常简单:
字典键是issuenumber
;函数需要issueNumber
(注意大写N
)。因此,要么将函数更改为使用小写issuenumber
,要么将参数解析器更改为store the value in issueNumber
。