Quantcast
Channel: CodeSection,代码区,Python开发技术文章_教程 - CodeSec
Viewing all articles
Browse latest Browse all 9596

通过Python的argparse模块解析命令行选项

$
0
0

作者:杨冬 欢迎转载,也请保留这段声明。谢谢!

出处: https://andyyoung01.github.io/ 或 http://andyyoung01.16mb.com/

如果想要通过python写出一个基于命令行的程序,如果程序的命令行参数较多,可以使用Python内置的argparse模块来处理命令行参数。

可以通过一个实例程序来探索argparse的用法:

search.py

import argparse parser = argparse.ArgumentParser(description='Search some files') parser.add_argument(dest='filenames',metavar='filename', nargs='*') parser.add_argument('-p', '--pat',metavar='pattern', required=True, dest='patterns', action='append', help='text pattern to search for') parser.add_argument('-v', dest='verbose', action='store_true', help='verbose mode') parser.add_argument('-o', dest='outfile', action='store', help='output file') parser.add_argument('--speed', dest='speed', action='store', choices={'slow','fast'}, default='slow', help='search speed') args = parser.parse_args() # Output the collected arguments print(args.filenames) print(args.patterns) print(args.verbose) print(args.outfile) print(args.speed)

可以通过如下的方式使用上面定义的脚本文件:

[yangdong@centos7 ~]$ python3 search.py -h usage: search.py [-h] [-p pattern] [-v] [-o OUTFILE] [--speed {slow,fast}] [filename [filename ...]] Search some files positional arguments: filename optional arguments: -h, --help show this help message and exit -p pattern, --pat pattern text pattern to search for -v verbose mode -o OUTFILE output file --speed {slow,fast} search speed [yangdong@centos7 ~]$ python3 search.py foo.txt bar.txt usage: search.py [-h] -p pattern [-v] [-o OUTFILE] [--speed {fast,slow}] [filename [filename ...]] search.py: error: the following arguments are required: -p/--pat [yangdong@centos7 ~]$ python3 search.py -v -p spam --pat=eggs foo.txt bar.txt filenames = ['foo.txt', 'bar.txt'] patterns = ['spam', 'eggs'] verbose = True outfile = None speed = slow [yangdong@centos7 ~]$ python3 search.py -v -p spam --pat=eggs foo.txt bar.txt -o results filenames = ['foo.txt', 'bar.txt'] patterns = ['spam', 'eggs'] verbose = True outfile = results speed = slow [yangdong@centos7 ~]$ python3 search.py -v -p spam --pat=eggs foo.txt bar.txt -o results \ --speed=fast filenames = ['foo.txt', 'bar.txt'] patterns = ['spam', 'eggs'] verbose = True outfile = results speed = fast

为了解析命令行选项,你首先要创建一个 ArgumentParser 实例, 并使用 add_argument() 方法声明你想要支持的选项。 在每个 add_argument() 调用中, dest 参数指定将解析结果存入以该参数命名的属性中。 metavar 参数被用来生成帮助信息。 action 参数指定跟属性对应的处理逻辑,通常的值为 store ,被用来存储某个值或将多个参数值收集到一个列表中。 更详细的add_argument()的参数解释请参考 这里 。

在设置完参数后,便可以执行 parser.parse() 方法了。它会处理 sys.argv 的值并返回一个结果实例。每个参数值都会被设置成该实例中 add_argument() 方法的 dest 参数指定的属性值。

还很多种其他方法解析命令行选项。 例如,你可能会手动的处理 sys.argv 或者使用 getopt 模块。 但是,如果你采用本节的方式,将会减少很多冗余代码,底层细节 argparse 模块已经帮你处理了。 你可能还会碰到使用 optparse 库解析选项的代码。 尽管 optparse 和 argparse 很像,但是后者更先进,因此在新的程序中你应该使用它。


Viewing all articles
Browse latest Browse all 9596

Trending Articles