此模块有中文文档,建议看到此文的读者链接到中文文档查看,本文只是自己学习、个人理解的重点总结
argparse模块 官方文档
argparse是一个Python模块:命令行选项、参数和子命令解析器。
argparse 模块可以让人轻松编写用户友好的命令行接口。程序定义它需要的参数,然后 argparse 将弄清如何从 sys.argv 解析出那些参数。 argparse 模块还会自动生成帮助和使用手册,并在用户给程序传入无效参数时报出错误信息。
使用流程
创建解析器
parser
= argparse
.ArgumentParser
(description
='Process some integers.')
使用 argparse 的第一步是创建一个 ArgumentParser 对象。
ArgumentParser 对象包含将命令行解析成 Python 数据类型所需的全部信息。
添加参数
parser
.add_argument
('integers', metavar
='N', type=int, nargs
='+', help='an integer for the accumulator')
给一个 ArgumentParser 添加程序参数信息是通过调用 add_argument() 方法完成的。
解析参数
>>> parser
.parse_args
(['--sum', '7', '-1', '42'])
Namespace
(accumulate
=<built
-in function
sum>, integers
=[7, -1, 42])
ArgumentParser 通过 parse_args() 方法解析参数。
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)
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)
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() 所返回对象上的属性名。