python - 使用 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 parse 来达到此目的，但无法正确放置它。现在，我正在做。

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，然后调用 get all 函数并检查车辆类型。有没有更好的方法来正确使用argparse，使代码更加紧凑。

Answer 1

(我认为)做你想做的事情的一个相对直接的方法是:

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 属性和 值 的自定义操作方法

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)

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