Python argparse 상호 배타적 그룹


88

내가 필요한 것은 :

pro [-a xxx | [-b yyy -c zzz]]

나는 이것을 시도했지만 작동하지 않습니다. 누군가 나를 도울 수 있습니까?

group= parser.add_argument_group('Model 2')
group_ex = group.add_mutually_exclusive_group()
group_ex.add_argument("-a", type=str, action = "store", default = "", help="test")
group_ex_2 = group_ex.add_argument_group("option 2")
group_ex_2.add_argument("-b", type=str, action = "store", default = "", help="test")
group_ex_2.add_argument("-c", type=str, action = "store", default = "", help="test")

감사!



플러그를 꽂았지만 내 라이브러리 joffrey 를 언급하고 싶었습니다 . 예를 들어 하위 명령을 사용하거나 (수락 된 답변에서와 같이) 모든 것을 직접 검증하지 않고 (두 번째로 높은 투표를받은 응답에서와 같이)이 질문이 원하는 것을 수행 할 수 있습니다.
안녕하세요

답변:


109

add_mutually_exclusive_group전체 그룹을 상호 배타적으로 만들지 않습니다. 그룹 내의 옵션을 상호 배타적으로 만듭니다.

당신이 찾고있는 것은 하위 명령 입니다. prog 대신 [-a xxxx | [-b yyy -c zzz]], 당신은 :

prog 
  command 1 
    -a: ...
  command 2
    -b: ...
    -c: ...

첫 번째 인수 세트로 호출하려면 다음을 수행하십시오.

prog command_1 -a xxxx

두 번째 인수 세트를 사용하여 호출하려면 다음을 수행하십시오.

prog command_2 -b yyyy -c zzzz

하위 명령 인수를 위치로 설정할 수도 있습니다.

prog command_1 xxxx

git 또는 svn과 같은 종류 :

git commit -am
git merge develop

작업 예

# create the top-level parser
parser = argparse.ArgumentParser(prog='PROG')
parser.add_argument('--foo', action='store_true', help='help for foo arg.')
subparsers = parser.add_subparsers(help='help for subcommand')

# create the parser for the "command_1" command
parser_a = subparsers.add_parser('command_1', help='command_1 help')
parser_a.add_argument('a', type=str, help='help for bar, positional')

# create the parser for the "command_2" command
parser_b = subparsers.add_parser('command_2', help='help for command_2')
parser_b.add_argument('-b', type=str, help='help for b')
parser_b.add_argument('-c', type=str, action='store', default='', help='test')

테스트

>>> parser.print_help()
usage: PROG [-h] [--foo] {command_1,command_2} ...

positional arguments:
  {command_1,command_2}
                        help for subcommand
    command_1           command_1 help
    command_2           help for command_2

optional arguments:
  -h, --help            show this help message and exit
  --foo                 help for foo arg.
>>>

>>> parser.parse_args(['command_1', 'working'])
Namespace(a='working', foo=False)
>>> parser.parse_args(['command_1', 'wellness', '-b x'])
usage: PROG [-h] [--foo] {command_1,command_2} ...
PROG: error: unrecognized arguments: -b x

행운을 빕니다.


나는 이미 그것들을 논쟁 그룹에 넣었습니다. 이 경우 하위 명령을 어떻게 추가 할 수 있습니까? 감사!
Sean

1
샘플 코드로 업데이트되었습니다. 그룹이 아니라 하위 구문 분석기를 사용합니다.
Jonathan

6
그러나 OP가 원래 요청한 것을 어떻게 하시겠습니까? 나는 현재 하위 명령 세트를 가지고 있지만, 그 하위 명령 중 하나를 선택할 수있는 능력을 필요로 하는가[[-a <val>] | [-b <val1> -c <val2>]]
code_dredd

2
"noname"명령을 내리고 OP가 요청한 것을 달성 할 수 없기 때문에 질문에 대한 답이 아닙니다.[-a xxx | [-b yyy -c zzz]]
The Godfather

34

하지만 조나단의 대답은 복잡한 옵션을 완벽하게 괜찮지이 다른 옵션처럼 1 명 옵션 제외를 예, 간단한 경우에 작동하는 매우 간단한 해결책이있다

command [- a xxx | [ -b yyy | -c zzz ]] 

또는 원래 질문에서와 같이 :

pro [-a xxx | [-b yyy -c zzz]]

다음은 내가하는 방법입니다.

parser = argparse.ArgumentParser()

# group 1 
parser.add_argument("-q", "--query", help="query", required=False)
parser.add_argument("-f", "--fields", help="field names", required=False)

# group 2 
parser.add_argument("-a", "--aggregation", help="aggregation",
                    required=False)

mongodb를 쿼리하기 위해 명령 줄 래퍼에 주어진 옵션을 사용하고 있습니다. collection인스턴스 중 하나 메서드를 호출 할 수 있습니다 aggregate또는 방법을 find선택적 인수에 함께 query하고 fields처음 두 인수가 호환되며 마지막 하나가없는 이유 때문에 당신이 볼.

이제 실행 parser.parse_args()하고 내용을 확인합니다.

args = parser().parse_args()

print args.aggregation
if args.aggregation and (args.query or args.fields):
    print "-a and -q|-f are mutually exclusive ..."
    sys.exit(2)

물론이 작은 해킹은 단순한 경우에만 작동하며 상호 배타적 인 옵션과 그룹이 많은 경우 가능한 모든 옵션을 확인하는 것은 악몽이 될 것입니다. 이 경우 옵션을 Jonathan이 제안한 명령 그룹으로 분리해야합니다.


5
더 읽기 쉽고 관리하기 쉬운 것처럼 보이기 때문에이 경우를 '해킹'이라고 부르지 않습니다. 지적 해 주셔서 감사합니다!
sage

13
더 나은 방법은 parser.error("-a and -q ..."). 이렇게하면 완전한 사용 도움말이 자동으로 인쇄됩니다.
WGH

이 경우 당신은 또한 같은 사례를 검증 할 필요가 있음을하시기 바랍니다 참고 사항 : (1) 모두 qf첫 번째 그룹에 필요한 사용자, (2) 중 하나의 그룹이 필요하다. 그리고 이것은 "간단한"솔루션을 더 이상 단순하지 않게 만듭니다. 그래서 나는 이것이 손으로 만든 스크립트에 대한 더 많은 해킹이지만 실제 해결책은 아니라는 데 동의 할 것입니다
The Godfather

4

이 작업을 수행 할 수있는 파이썬 패치 (개발 중)가 있습니다.
http://bugs.python.org/issue10984

아이디어는 겹치는 상호 배타적 인 그룹을 허용하는 것입니다. 따라서 usage다음과 같이 보일 수 있습니다.

pro [-a xxx | -b yyy] [-a xxx | -c zzz]

이렇게 두 그룹을 만들 수 있도록 argparse 코드를 변경하는 것은 쉬운 부분이었습니다. usage서식 코드를 변경하려면 사용자 지정 HelpFormatter.

에서은 argparse, 액션 그룹은 구문 분석에 영향을 미치지 않습니다. help형식화 도구 일뿐 입니다. 에서 help, 상호 배타적 인 그룹에만 영향을 usage줄. 파싱하면은 parser충돌 가능성의 사전 (구성하는 상호 배타적 인 그룹을 사용하여 a발생할 수 b또는 c, b발생할 수없는 a등), 그리고 충돌이 발생하는 경우 오류를 일으킨다.

그 argparse 패치없이, 당신의 최선의 선택에 의해 생성 된 네임 스페이스를 테스트하는 것입니다 생각하는 parse_args자신을 (예를 들어, 만약 둘 ab기본이 아닌 값이), 그리고 자신의 오류를 발생. 파서 자체의 오류 메커니즘을 사용할 수도 있습니다.

parser.error('custom error message')

1
Python 문제 : bugs.python.org/issue11588 은 사용자 지정 독점 / 포함 테스트를 작성할 수있는 방법을 찾고 있습니다.
hpaulj
당사 사이트를 사용함과 동시에 당사의 쿠키 정책개인정보 보호정책을 읽고 이해하였음을 인정하는 것으로 간주합니다.
Licensed under cc by-sa 3.0 with attribution required.