Python argparse：命令行参数解析工具

在Python应用程序中，始终存在一些参数需要在运行时设置。例如，在运行Python脚本时，我们可能需要指示脚本读取的文件的位置或要执行哪个函数等等。Python argparse库提供了一种方便而灵活的方法处理命令行参数。argparse模块帮助我们定义和解析命令行参数，自动生成帮助文档。

一、添加命令行参数

argparse库让我们能够轻松地定义命令行参数。我们可以使用add_argument()方法来添加我们需要的参数。

import argparse

if __name__ == '__main__':
    parser = argparse.ArgumentParser(description='Process some integers.')
    parser.add_argument('integers', metavar='N', type=int, nargs='+',
                        help='an integer for the accumulator')
    parser.add_argument('--sum', dest='accumulate', action='store_const',
                        const=sum, default=max,
                        help='sum the integers (default: find the max)')
    args = parser.parse_args()
    print(args.accumulate(args.integers))

在上面的示例中，我们定义了一个描述性的解析器实例。我们通过调用add_argument()方法来指定我们想要的参数变量的名称并给出帮助信息。在我们的例子中，’integers’参数是必需的，并且可以接受多个整数值。我们还定义了一个可选的’–sum’参数来指示argparse计算总和而不是查找最大值。在解析命令行参数之后，输出函数结果。

二、使用简洁参数

有时你可能想在命令行中使用一个简单的参数放在开头以启动某些操作。例如，你可以使用一个’-v’参数来启用程序的详细模式。

import argparse

if __name__ == '__main__':
    parser = argparse.ArgumentParser(description='Process some integers.')
    parser.add_argument('-v', '--verbose', dest='verbose', action='store_true',
                        help='increase output verbosity')
    args = parser.parse_args()
    
    if args.verbose:
        print('Verbose mode is on')
    else:
        print('Verbose mode is off')

在以上示例中，我们添加了一个简洁的参数’-v’和一个对应的参数’–verbose’。我们使用’store_true’属性来将参数’true’值存储到我们的args命名空间中表示希望打印详细的输出。

三、定义互斥参数

有时，我们需要在多个选项中只选一个。例如，在一个应用程序中，我们可能需要使用’-r’选项删除某个文件，或者使用’-l’选项列出某个目录。为了避免混淆并提高代码错误率，我们希望同时选一-h’参数和’-l’或’-r’的参数选项。解决这个问题的一种方式是使用互斥组。

import argparse

if __name__ == '__main__':
    parser = argparse.ArgumentParser(description='Process some integers.')
    group = parser.add_mutually_exclusive_group()
    group.add_argument('-l', '--list', action='store_true', help='list directory contents')
    group.add_argument('-r', '--remove', action='store_true', help='remove file')
    parser.add_argument('-v', '--verbose', dest='verbose', action='store_true',
                        help='increase output verbosity')
    args = parser.parse_args()

    if args.list:
        print('List mode is on')
    elif args.remove:
        print('Remove mode is on')
    else:
        parser.print_help()

在以上示例中，我们使用了add_mutually_exclusive_group()方法来指定我们不希望同时设置’-l’和’-r’参数，因为它们都是有互斥的。只能选用其中之一。当’-l’选项被选中时，隐藏’–remove’选项，反之亦然。

四、指定参数的数据类型和范围

使用argparse库，我们可以指定参数的数据类型。有时，命令行参数需要具有特定的范围和数据类型(整数，浮点数等)。我们可以使用type属性来指定参数是什么数据类型，使用choices属性来定义列表范围，使用range属性来指定整数的取值范围。

import argparse

if __name__ == '__main__':
    parser = argparse.ArgumentParser(description='Process some integers.')
    parser.add_argument('--age', dest='age', type=int, 
                        choices=range(0, 130), help='Age in years')
    parser.add_argument('--gender', dest='gender', 
                        choices=['male', 'female'], help='Gender')
    args = parser.parse_args()

    if args.age and args.gender:
        print('Age: {}, Gender: {}'.format(args.age, args.gender))
    else:
        parser.print_help()

在以上示例中，我们使用type属性来指定’–age’参数是整数。我们还使用choices属性来定义该值的有效范围。类似地，对于’–gender’参数，我们使用choices属性来指定列表的有效性。

五、自动生成帮助

argparse库让我们可以轻松地生成程序使用帮助。如果我们要使用大量的复杂参数和选项，代码文档可能变得非常长。我们可以使用argparse库自动生成帮助信息。

import argparse

if __name__ == '__main__':
    parser = argparse.ArgumentParser(description='Process some integers.')
    parser.add_argument('--age', dest='age', type=int, 
                        choices=range(0, 130), help='Age in years')
    parser.add_argument('--gender', dest='gender', 
                        choices=['male', 'female'], help='Gender')
    parser.add_argument('--file', dest='file', type=argparse.FileType('w'),
                        help='Output file')
    args = parser.parse_args()

    if args.age and args.gender:
        print('Age: {}, Gender: {}'.format(args.age, args.gender))
    else:
        parser.print_help()

在以上示例中，我们添加了一个’–file’选项以将结果写入到文件中。我们使用argparse.FileType(‘w’)来创建一个新文件并将其绑定到该文件。运行脚本时，使用’-h’或’–help’可以输出程序的描述和所有指定参数的用法说明。

六、结论

Python argparse库是一种非常灵活的工具，可以简化Python应用程序中的命令行参数处理。它使我们能够定义argv字符串的类型、可选的参数与必选的参数、参数的有效或无效的值域检查和自动生成帮助文档等等。使用argparse库，我们能够轻松地解析和处理命令行参数，使我们的程序更容易使用和维护。