Python, argparse: включить входной параметр, когда указан другой

Ответ 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(...). например.

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))

Ответ 2

Одной из идей было бы вручную проверить вывод вызова parser.parse_args() и поднять исключение или иначе сбой, если используется --parameter2, но --parameter1 нет.

Вы также можете попробовать установить пользовательское действие (прокрутите вниз) до --parameter2, проверьте, существует ли --parameter1 внутри пространства имен.

Наконец, вы можете попробовать использовать subparsers, хотя я не знаю, позволит ли это указать значение для --parameter1.

Ответ 3

Вы можете использовать parse_known_args(), чтобы проверить, было ли указано --parameter1, перед добавлением --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