如在argparse中使用互斥参数?

时间:2014-08-05 17:42:56

标签: python argparse command-line-interface

命令行中必读的一些数据列表(例如电子邮件地址):

some_util -l email1@x.com email2@x.com

或来自档案:

some_util -L email.lst

如何在argparse中无法使用两个键-l和-L的组合

import argparse
import sys
def createCLParser():
    parser = argparse.ArgumentParser()
    parser.add_argument('-l', '--list', nargs='+', help='list from comand line')
    parser.add_argument('-L', '--list-file', type=argparse.FileType(), help='list from file')
    return parser
if __name__ == '__main__':
    parser = createCLParser()
    namespace = parser.parse_args(sys.argv[1:])

在argparse中,方法是 add_mutually_exclusive_group(),但它必须是可选的。

2 个答案:

答案 0 :(得分:1)

.add_mutually_exclusive_group()方法与required=True

一起使用
import argparse
import sys
def createCLParser():
    parser = argparse.ArgumentParser()
    group = parser.add_mutually_exclusive_group(required=True)
    group.add_argument('-l', '--list', nargs='+', help='list from comand line')
    group.add_argument('-L', '--list-file', type=argparse.FileType(), help='list from file')

    return parser
if __name__ == '__main__':
    parser = createCLParser()
    namespace = parser.parse_args(sys.argv[1:])
    print namespace

用法:

$ python ar.py 
usage: ar.py [-h] (-l LIST [LIST ...] | -L LIST_FILE)
ar.py: error: one of the arguments -l/--list -L/--list-file is required

$ python ar.py -l foo@example.com
Namespace(list=['foo@example.com'], list_file=None)

$ python ar.py -l foo@example.com -L bar
usage: ar.py [-h] (-l LIST [LIST ...] | -L LIST_FILE)
ar.py: error: argument -L/--list-file: not allowed with argument -l/--list

答案 1 :(得分:0)

由于其中一个是必需的,因此该用例更适合子命令:

some_util fromList email1@x.com email2@x.com

some_util fromFile email.lst

代码类似于

import argparse

parser = argparse.ArgumentParser()
subparsers = parser.add_subparsers()
addr_parser = subparsers.add_parser("fromList")
file_parser = subparsers.add_parser("fromFile")

addr_parser.add_argument("addresses", nargs="+")
addr_parser.setdefaults(command="fromList")
file_parser.add_argument("address_file")
file_parser.setdefaults(command="fromFile")

parser.set_defaults(
args = parser.parse_args()

if args.command == "fromList":
    # use args.addresses
elif args.command == "fromFile":
    # read addresses from file named by args.address_file