使用 argparse 的建议

Question

我正在编写一个 python 命令行客户端程序来与 api 交互。用户使用客户端程序运行以下命令，客户端程序对 api

进行以下示例调用

python run.py --car --> calls method get_all(vehicle_type) which requests--> /car/all --< which returns list of all cars

python run.py --van --> /van/all --> which returns list of all vans

/car/id/123 --> --> calls method get_by_id(vehicle_type, id) which requests --> returns list of car with id 123

所有其他人都类似。

/car/color/red return list of car with color red

/car/model_no/31x return car with model_no 31x

/van/id/312 returns list of van with id 321

我正在为此目的使用 arg 解析，但无法正确放置它。现在，我正在做。

parser = argparse.ArgumentParser()
grp1 = parser.add_mutually_exclusive_group(required=True)
grp2 = parser.add_mutually_exclusive_group()

grp1.add_argument('--car', action='store_const', const='car')
grp1.add_argument('--van', action='store_const', const='van')

grp2.add_argument('--id', help='get by id')
grp2.add_argument('--model_no', help='get by model number')
grp2.add_argument('--color', help='get by color') 

arg_dict = {k:v for k, v in vars(args).items() if v}

当我运行此代码用于命令时。

python run.py --car --id 123

我明白了

{'car' : 'car' , 'id' : '123'}

我正在遍历此字典并使用 getattr 通过键名 'get_by_{name}'.format(name = key) 调用函数。但是，我的代码看起来不太好，因为我必须检查长度是否为 1，然后调用获取所有函数并检查车辆类型。有没有更好的方法正确使用argparse让代码更紧凑

Answer 1

我发现在使用 mutually_exclusive_groups 时我经常使用 dest option 所以你有一个具有动态值的变量：

import argparse

parser = argparse.ArgumentParser()
grp1 = parser.add_mutually_exclusive_group(required=True)
grp2 = parser.add_mutually_exclusive_group()

group_1_options = {"action":"store_const",'dest':"vehicle"}

grp1.add_argument('--car', const="car", **group_1_options)
grp1.add_argument('--van', const='van', **group_1_options)

然后对于第二组，您可以使用 type 在指定选项时应用更改，以便它保存对指定选项文本的引用：

parser.set_defaults(request=("get_all",None))

request_args = {"id":'get by id',
                "model_no":"get by model number",
                "color":"get by color"}

grp2 = parser.add_mutually_exclusive_group()
for arg_name, help_text in request_args.items():
    grp2.add_argument("--"+arg_name, help=help_text, dest="request",
                      type=(lambda x, arg_text=arg_name:(arg_text,x)))

然后可以像这样检索请求：

def test(argline):
    namespace = parser.parse_args(argline.split())
    kind,value = namespace.request
    print(namespace.vehicle, kind, value)

那么你保证只需要处理 vehicle 和 request 选项：

>>> test("--van")
van get_all None
>>> test("--car --id 123")
car id 123
>>> test("--model_no 55 --van")
van model_no 55
>>> test("--car --id") #invalid because there is no request value
usage: test.py [-h] (--car | --van)
               [--color REQUEST | --id REQUEST | --model_no REQUEST]
test.py: error: argument --id: expected one argument

Answer 2

一个相对直接的做你想做的事情的方法（我认为）是：

import argparse

def get_all(vehicle_type, *value):   # optional value parameter
    print('all', vehicle_type)

def get_by_id(vehicle_type, id):
    print('id', vehicle_type, id)

def get_by_color(vehicle_type, color):
    print('color', vehicle_type, color)

def get_by_model(vehicle_type, model):
    print('model', vehicle_type, model)

parser = argparse.ArgumentParser()
parser.add_argument('--vehicle_type','-v',choices=['car','van'])
# could be mutually exclusive group with --car and --var

getby_group = parser.add_mutually_exclusive_group()
getby_group.add_argument('--id')
getby_group.add_argument('--color')
getby_group.add_argument('--model')

args = parser.parse_args()

if args.id:
    get_by_id(args.vehicle_type, args.id)
elif args.color:
    get_by_color(args.vehicle_type, args.color)
elif args.model:
    get_by_model(args.vehicle_type, args.model)
else:
    get_all(args.vehicle_type)

您可以使用 default=argparse.SUPPRESS 将 id 排除在 args 之外（就像您对 arg_dict = {k:v for k, v in vars(args).items() if v} 所做的那样）。但是更容易测试

if args.id:
   ...

比

if hasattr(args,'id'):
    ...

或

if get(vars,'id',None):
     ...

如果您真的想从 args 值生成函数名称，您可以进行字典查找（locals() 或自定义字典）。在内部 argparse 通过 parser.register.

使用 registries 字典

fn = locals().get('get_by_%s'%'id')
fn(args.vehicle_type, args.id)

argparse 文档展示了如何使用 parser.set_defaults 将 args 属性定义为函数。但该特定用途仅适用于子解析器。

你可以使用const来设置一个函数，例如

getby_group.add_argument('--id',dest='fn',action='store_const', const=get_by_id)

然后

args.fn(...)

运行 get_by_id 会起作用。

< 删除了一个使用此 store_const 的版本。它在接受一个值时遇到了问题；为详细信息设置编辑历史 >

===================

这是定义 fn 属性和 value

的自定义操作方法

class GetAction(argparse._StoreAction):
    # barest customization
    def __init__(self, *args, **kwargs):
        fn=kwargs.pop('fn')
        super(GetAction, self).__init__(*args, **kwargs)
        self.fn = fn 
    def __call__(self, parser, namespace, values, option_string=None):
        super(GetAction, self).__call__(parser, namespace, values, option_string=None)
        setattr(namespace, 'fn', self.fn)

parser.set_defaults(fn=get_all)  # default action    
getby_group.add_argument('--id',   dest='value', action=GetAction, fn=get_by_id)
getby_group.add_argument('--color',dest='value', action=GetAction, fn=get_by_color)
getby_group.add_argument('--model',dest='value', action=GetAction, fn=get_by_model)
args = parser.parse_args()
args.fn(args.vehicle_type, args.value)

但是 - 注意 class 定义比 if-else 树需要更多的代码行。并且花了我更长的时间来写。

使用 argparse 的建议

Advice for using argparse

python

argparse