Python命令行解析器--ArgumentParser

59 阅读 0 评论 39 点赞

我是靠谱客的博主彪壮小甜瓜，最近开发中收集的这篇文章主要介绍Python命令行解析器--ArgumentParser，觉得挺不错的，现在分享给大家，希望可以做个参考。

概述

Python命令行选项、参数和子命令解析器

Windows命令行是Windows内置的Shell，我们可以用命令行批处理(bat)快速处理批量任务，通过argparse模块对Python脚本传递参数。

使用 argparse 的第一步是创建一个 ArgumentParser 对象：

parser = argparse.ArgumentParser(description='Process some integers.')

ArgumentParser 对象
class argparse.ArgumentParser(prog=None, usage=None, description=None, epilog=None, parents=[], formatter_class=argparse.HelpFormatter, prefix_chars=’-’, fromfile_prefix_chars=None, argument_default=None, conflict_handler=‘error’, add_help=True, allow_abbrev=True, exit_on_error=True)
创建一个新的 ArgumentParser 对象。所有的参数都应当作为关键字参数传入。每个参数在下面都有它更详细的描述，但简而言之，它们是：

prog - 程序的名称（默认：sys.argv[0]）
usage - 描述程序用途的字符串（默认值：从添加到解析器的参数生成）
description - 在参数帮助文档之前显示的文本（默认值：无）
epilog - 在参数帮助文档之后显示的文本（默认值：无）
parents - 一个 ArgumentParser 对象的列表，它们的参数也应包含在内
formatter_class - 用于自定义帮助文档输出格式的类
prefix_chars - 可选参数的前缀字符集合（默认值：’-’）
fromfile_prefix_chars - 当需要从文件中读取其他参数时，用于标识文件名的前缀字符集合（默认值：None）
argument_default - 参数的全局默认值（默认值： None）
conflict_handler - 解决冲突选项的策略（通常是不必要的）
add_help - 为解析器添加一个 -h/–help 选项（默认值： True）
allow_abbrev - 如果缩写是无歧义的，则允许缩写长选项（默认值：True）
exit_on_error - 决定当错误发生时是否让 ArgumentParser 附带错误信息退出。 (默认值: True)

add_argument()方法
ArgumentParser.add_argument(name or flags…[, action][, nargs][, const][, default][, type][, choices][, required][, help][, metavar][, dest])
定义单个的命令行参数应当如何解析。每个形参都在下面有它自己更多的描述，

name or flags - 一个命名或者一个选项字符串的列表，例如 foo 或 -f, --foo。
action - 当参数在命令行中出现时使用的动作基本类型。
nargs - 命令行参数应当消耗的数目。
const - 被一些 action 和 nargs 选择所需求的常数。
default - 当参数未在命令行中出现并且也不存在于命名空间对象时所产生的值。
type - 命令行参数应当被转换成的类型。
choices - 可用的参数的容器。
required - 此命令行选项是否可省略（仅选项可用）。
help - 一个此选项作用的简单描述。
metavar - 在使用方法消息中使用的参数值示例。
dest - 被添加到 parse_args() 所返回对象上的属性名。

parse_args() 方法
ArgumentParser.parse_args(args=None, namespace=None)
将参数字符串转换为对象并将其设为命名空间的属性。返回带有成员的命名空间。

之前对 add_argument() 的调用决定了哪些对象被创建以及它们如何被赋值。

args - 要解析的字符串列表。默认值是从 sys.argv 获取。
namespace - 用于获取属性的对象。默认值是一个新的空 Namespace 对象。

ArgumentParser用法演示
现在我们可以写一个Python的测试脚本TestCMD.py，使用Windows命令行Command.exe，传递两个文件参数给TestCMD.py的ArgumentParser对象，并通过args.commanderPath, args.firmwarePath来引用这两个文件。

python TestCMD.py -c commander.exe
-f Z3SwitchSoc.hex

if __name__ == "__main__":
import argparse
parser = argparse.ArgumentParser(description = SCRIPT_DESC)
parser.add_argument('-c',
'--commanderPath',
required=True,
help="Path to Simplicity Commander. Found in Simplicity Studio path under /developer/adapter_packs/commander/commander.exe" )
parser.add_argument('-b',
'--bootloaderPath',
help="Path to bootloader .hex file" )
parser.add_argument('-f',
'--firmwarePath',
help="Path to firmware .hex file" )
args = parser.parse_args()
flashHexFile(args.commanderPath, args.firmwarePath)