没有提供参数时,python argparse设置行为

时间:2013-01-16 12:42:58

标签: python python-2.7 argparse

我是python的新手,在使用命令行参数时,我一直坚持如何构造我的简单脚本。

该脚本的目的是在我的工作中自动执行与排序和操作图像相关的一些日常任务。

我可以指定参数并让它们调用相关函数,但我也想在没有提供参数时设置默认操作。

这是我目前的结构。

parser = argparse.ArgumentParser()
parser.add_argument("-l", "--list", help="Create CSV of images", action="store_true")
parser.add_argument("-d", "--dimensions", help="Copy images with incorrect dimensions to new directory", action="store_true")
parser.add_argument("-i", "--interactive", help="Run script in interactive mode", action="store_true")
args = parser.parse_args()

if args.list:
    func1()
if args.interactive:
    func2()
if args.dimensions:
    func3()

但是当我没有提供任何参数时,将不会调用任何内容。

Namespace(dimensions=False, interactive=False, list=False)

如果没有提供争论,我想要的是一些默认行为

if args.list:
        func1()
    if args.interactive:
        func2()
    if args.dimensions:
        func3()
    if no args supplied:
        func1()
        func2()
        func3()

这似乎应该相当容易实现但是我迷失了如何检测所有参数是错误的逻辑而没有循环遍历参数并测试是否所有都是假的。

更新

多个参数一起有效,这就是为什么我没有沿着elif路线走下去。

更新2

这是我更新的代码,考虑了@unutbu的答案

它似乎并不理想,因为所有内容都包含在if语句中,但在短期内我无法找到更好的解决方案。我很高兴接受来自@unutbu的答复,所提供的任何其他改进都将不胜感激。

lists = analyseImages()
    if lists:
        statusTable(lists)

        createCsvPartial = partial(createCsv, lists['file_list'])
        controlInputParital = partial(controlInput, lists)
        resizeImagePartial = partial(resizeImage, lists['resized'])
        optimiseImagePartial = partial(optimiseImage, lists['size_issues'])
        dimensionIssuesPartial = partial(dimensionIssues, lists['dim_issues'])

        parser = argparse.ArgumentParser()
        parser.add_argument(
        "-l", "--list", 
        dest='funcs', action="append_const", const=createCsvPartial,
        help="Create CSV of images",)
        parser.add_argument(
        "-c", "--convert", 
        dest='funcs', action="append_const", const=resizeImagePartial,
        help="Convert images from 1500 x 2000px to 900 x 1200px ",)
        parser.add_argument(
        "-o", "--optimise", 
        dest='funcs', action="append_const", const=optimiseImagePartial,    
        help="Optimise filesize for 900 x 1200px images",)
        parser.add_argument(
        "-d", "--dimensions", 
        dest='funcs', action="append_const", const=dimensionIssuesPartial,
        help="Copy images with incorrect dimensions to new directory",)
        parser.add_argument(
        "-i", "--interactive", 
        dest='funcs', action="append_const", const=controlInputParital,
        help="Run script in interactive mode",)
        args = parser.parse_args()

        if not args.funcs:
            args.funcs = [createCsvPartial, resizeImagePartial, optimiseImagePartial, dimensionIssuesPartial]

        for func in args.funcs:
            func()

    else:
        print 'No jpegs found'

3 个答案:

答案 0 :(得分:7)

您可以append_const funcs属性args.funcs,然后使用一个if语句提供默认行为,如果没有设置选项:

if not args.funcs:
    args.funcs = [func1, func2, func3]

import argparse

def func1(): pass
def func2(): pass
def func3(): pass

parser = argparse.ArgumentParser()
parser.add_argument(
    "-l", "--list",
    dest='funcs', action="append_const", const=func1,
    help="Create CSV of images", )
parser.add_argument(
    "-i", "--interactive",
    dest='funcs', action="append_const", const=func2,
    help="Run script in interactive mode",)
parser.add_argument(
    "-d", "--dimensions",
    dest='funcs', action='append_const', const=func3,
    help="Copy images with incorrect dimensions to new directory")
args = parser.parse_args()
if not args.funcs:
    args.funcs = [func1, func2, func3]

for func in args.funcs:
    print(func.func_name)
    func()

% test.py
func1
func2
func3

% test.py -d
func3

% test.py -d -i
func3
func2

请注意,与原始代码不同,这允许用户控制调用函数的顺序:

% test.py -i -d
func2
func3

这可能是也可能不是。


回应更新2

您的代码可以正常运行。但是,这是另一种组织方式:

  • 不是将主程序嵌套在if子句中,而是可以 使用

    if not lists:
        sys.exit('No jpegs found')
    # put main program here, unnested
    

    sys.exit会将No jpegs found打印到stderr,并以退出代码1终止。

  • 虽然我最初建议使用functools.partial,但现在想到另一种 - 或许更简单 - 的方式:而不是

    for func in args.funcs:
        func()
    

    我们可以说

    for func, args in args.funcs:
        func(args)
    

    我们需要做的就是在(func, args)中存储元组args.func 而不仅仅是功能。

例如:

import argparse
import sys

def parse_args(lists):
    funcs = {
        'createCsv': (createCsv, lists['file_list']),
        'resizeImage': (resizeImage, lists['resized']),
        'optimiseImage': (optimiseImage, lists['size_issues']),
        'dimensionIssues': (dimensionIssues, lists['dim_issues']),
        'controlInput': (controlInput, lists)
    }
    parser = argparse.ArgumentParser()
    parser.add_argument(
        "-l", "--list",
        dest='funcs', action="append_const", const=funcs['createCsv'],
        help="Create CSV of images",)
    parser.add_argument(
        "-c", "--convert",
        dest='funcs', action="append_const", const=funcs['resizeImage'],
        help="Convert images from 1500 x 2000px to 900 x 1200px ",)
    parser.add_argument(
        "-o", "--optimise",
        dest='funcs', action="append_const", const=funcs['optimiseImage'],
        help="Optimise filesize for 900 x 1200px images",)
    parser.add_argument(
        "-d", "--dimensions",
        dest='funcs', action="append_const", const=funcs['dimensionIssues'],
        help="Copy images with incorrect dimensions to new directory",)
    parser.add_argument(
        "-i", "--interactive",
        dest='funcs', action="append_const", const=funcs['controlInput'],
        help="Run script in interactive mode",)
    args = parser.parse_args()
    if not args.funcs:
        args.funcs = [funcs[task] for task in
                      ('createCsv', 'resizeImage', 'optimiseImage', 'dimensionIssues')]
    return args

if __name__ == '__main__':
    lists = analyseImages()

    if not lists:
        sys.exit('No jpegs found')

    args = parse_args(lists)   
    statusTable(lists)    
    for func, args in args.funcs:
        func(args)

答案 1 :(得分:3)

这就是你想要的吗?

if args.list:
    func1()
if args.interactive:
    func2()
if args.dimensions:
    func3()
if not any(vars(args).values()):
    func1()
    func2()
    func3()

(感谢@ J.F.Sebastian了解any版本)

答案 2 :(得分:2)

你可以通过检查args的数量是否等于1来处理这个问题。这意味着只传递了你的python命令。

import argparse
import sys

parser = argparse.ArgumentParser()
parser.add_argument("-l", "--list", help="Create CSV of images", action="store_true")
parser.add_argument("-d", "--dimensions", help="Copy images with incorrect dimensions to new directory", action="store_true")
parser.add_argument("-i", "--interactive", help="Run script in interactive mode", action="store_true")
args = parser.parse_args()

if len(sys.argv)==1:
    # display help message when no args are passed.
    parser.print_help()
    sys.exit(1)