Question

在我的python脚本中，我希望能够在指定了另一个可选参数时使用可选的输入参数。例如：

$ python myScript.py --parameter1 value1
$ python myScript.py --parameter1 value1 --parameter2 value2

但不是：

$ python myScript.py --parameter2 value2

如何使用argparse执行此操作？

谢谢！

Answer 1

使用自定义操作：

import argparse

foo_default=None    

class BarAction(argparse.Action):
    def __call__(self,parser,namespace,values,option_string=None):
        didfoo=getattr(namespace,'foo',foo_default)
        if(didfoo == foo_default):
            parser.error( "foo before bar!")
        else:
            setattr(namespace,self.dest,values)

parser=argparse.ArgumentParser()
parser.add_argument('--foo',default=foo_default)
parser.add_argument('--bar',action=BarAction,help="Only use this if --foo is set")

#testing.
print parser.parse_args('--foo baz'.split())
print parser.parse_args('--foo baz --bar cat'.split())
print parser.parse_args('--bar dog'.split())

如果您依赖argparse的一些未记录的行为，这甚至可以通过更容易维护的方式完成：

import argparse

parser=argparse.ArgumentParser()
first_action=parser.add_argument('--foo',dest='cat',default=None)

class BarAction(argparse.Action):
    def __call__(self,parser,namespace,values,option_string=None):
        didfoo=getattr(namespace,first_action.dest,first_action.default)
        if(didfoo == first_action.default):
            parser.error( "foo before bar!")
        else:
            setattr(namespace,self.dest,values)

parser.add_argument('--bar',action=BarAction,
                    help="Only use this if --foo is set")

#testing.
print parser.parse_args('--foo baz'.split())
print parser.parse_args('--foo baz --bar cat'.split())
print parser.parse_args('--bar dog'.split())

在这个例子中，我们得到foo的默认值，它是add_argument返回的操作对象的目标（add_argument的返回值没有记录在我能找到的任何地方）。这仍然有点脆弱（例如，如果要为type=参数指定--foo关键字。）

最后，您可以在解析之前检查sys.argv。

import sys
if ("--parameter2" in sys.argv) and ("--parameter1" not in sys.argv):
    parser.error("parameter1 must be given if parameter2 is given")

如果--parameter1也可以触发--p1，这会变得有点棘手，但你明白了。然后你可以使用

if (set(sys.argv).intersection(('--p2',...)) and 
    not set(sys.argv).intersection(('--p1',...)))

这里的优点是它不需要任何特定的订单。（--p2不需要在命令行上关注--p1。并且，和以前一样，您可以通过option_strings返回的parser.add_argument(...)属性获取将触发您的特定操作的命令字符串列表。 e.g。

import argparse
import sys   
parser=argparse.ArgumentParser()
action1=parser.add_argument('--foo')
action2=parser.add_argument('--bar',
                            help="Only use this if --foo is set")

argv=set(sys.argv)
if (( argv & set(action2.option_strings) ) and 
      not ( argv & set(action1.option_strings) )):
                #^ set intersection
     parser.error(' or '.join(action1.option_strings)+
                  ' must be given with '+
                  ' or '.join(action2.option_strings))

Answer 2

在将--parameter1添加到解析器之前，您可以使用parse_known_args()检查是否已发出--parameter2。

import argparse

parser = argparse.ArgumentParser()
parser.add_argument('--parameter1', dest='p1')
args = parser.parse_known_args()[0]
if args.p1:
  parser.add_argument('--parameter2', dest='p2')
args = parser.parse_args()

if args.p1:
  print args.p1
if args.p2:
  print args.p2

结果：

$ python myScript.py --parameter1 a
a
$ python myScript.py --parameter1 a --parameter2 b
a
b
$ python myScript.py --parameter2 b
usage: myScript.py [-h] [--parameter1 P1]
myScript.py: error: unrecognized arguments: --parameter2 b

Answer 3

一个想法是手动检查调用parser.parse_args()的输出并引发异常，否则如果使用--parameter2但--parameter1不是，则会失败。

您还可以尝试设置custom action（向下滚动一下）到--parameter2检查命名空间内是否存在--parameter1。

最后，您可以尝试使用subparsers，但我不知道是否允许您为--parameter1指定值。

python，argparse：在指定了另一个参数时启用输入参数

3 个答案: