Pythonargparse相互排他グループ


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について言及したいと思います。たとえば、サブコマンドを使用せずに(受け入れられた回答のように)、またはすべてを自分で検証することなく(2番目に投票数の多い回答のように)、この質問が望むことを実行できます。
ハロー

回答:


109

add_mutually_exclusive_groupグループ全体を相互に排他的にするわけではありません。これにより、グループ内のオプションが相互に排他的になります。

あなたが探しているのはサブコマンドです。progの代わりに[-axxxx | [-b yyy -c zzz]]、次のようになります。

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

引数の最初のセットで呼び出すには:

prog command_1 -a xxxx

引数の2番目のセットで呼び出すには:

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

幸運を。


私はすでにそれらを議論グループの下に置いています。この場合、どうすればサブコマンドを追加できますか?ありがとう!
ショーン

1
サンプルコードで更新。グループは使用しませんが、サブパーサーを使用します。
ジョナサン

6
しかし、OPが最初に求めたことをどのように行いますか?現在、一連のサブコマンドがありますが、それらのサブコマンドの1[[-a <val>] | [-b <val1> -c <val2>]]
つには

2
これは、「noname」コマンドを作成してOPが要求したことを達成できないため、質問に答えません[-a xxx | [-b yyy -c zzz]]
ゴッドファーザー

34

一方でジョナサンの答えは複雑なオプションについてはまったく問題あり、単純な場合のために働くだろう、非常に簡単な解決策、例えば1つのオプションの除外のように2つの他のオプションがあります

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オプションの引数にしてqueryfields最初の2つの引数は互換性があり、最後の1がない理由ので、あなたが見ます、。

だから今私は実行してその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)

もちろん、この小さなハックは単純なケースでのみ機能し、相互に排他的なオプションやグループが多数ある場合、考えられるすべてのオプションをチェックするのは悪夢になります。その場合、ジョナサンが提案したようなコマンドグループにオプションを分割する必要があります。


5
この場合、これを「ハック」とは呼びません。読みやすく、管理しやすいように見えるからです。指摘してくれてありがとう!
セージ

13
さらに良い方法は、を使用することparser.error("-a and -q ...")です。このようにして、完全な使用ヘルプが自動的に印刷されます。
WGH 2016

この場合には、あなたも同様のケースを検証する必要があることに注意してください:(1)を両方qf最初のグループで必要とされているが、ユーザ、(2)のいずれかのグループが必要とされています。そしてこれにより、「単純な」ソリューションはもはやそれほど単純ではなくなります。ですから、これは手作りのスクリプトのハックであることに同意しますが、実際の解決策ではありません
ゴッドファーザー

4

これを可能にするPythonパッチ(開発中)があります。
http://bugs.python.org/issue10984

アイデアは、相互に排他的なグループの重複を許可することです。したがって、次のusageようになります。

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

このように2つのグループを作成できるようにargparseコードを変更するのは簡単な部分でした。usage書式設定コードを変更するには、カスタムを作成する必要がありましたHelpFormatter

ではargparse、アクショングループは解析に影響を与えません。それらは単なるhelpフォーマットツールです。ではhelp、相互に排他的なグループはusage回線にのみ影響します。解析時に、parser(潜在的な競合の辞書を構築するために相互に排他的なグループを使用するaと発生することができないb、またはcbで発生することができないa等)、次いで競合が生じた場合にエラーが発生します。

そのargparseパッチがなければ、私はあなたの最良の選択をすることによって生成の名前空間をテストすることだと思いますparse_args(両方の場合など、自分自身をaし、bデフォルト以外の値を持つ)、そしてあなた自身のエラーを発生させます。パーサー独自のエラーメカニズムを使用することもできます。

parser.error('custom error message')

1
Pythonの問題:bugs.python.org/issue11588は、カスタムの排他的/包括的テストを作成できるようにする方法を模索しています。
hpaulj 2014年
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.