【argparse】命令行解析模块
基于python3.
简介
可参考:Argparse 教程
argparse,python中很好用的命令行解析模块,用import导入。该模块的作用就是从命令行读取参数,可以使代码修改参数更加快速便捷。
import argparse
parser = argparse.ArgumentParser(description="Demo of argparse")
parser.add_argument('--name', default='zhao')
args = parser.parse_args()
name = args.name
引入argparser包后,然后通过argparser.ArgumentParser函数生成argparser对象,其中的description描述这个argparser对象是干什么的,当我们在命令行显示帮助信息的时候会看到description描述的信息。通过对象的add_argument函数来添加参数name, 默认值为zhao,当代码运行时,没有在命令行提供该参数的值的话,该值默认采用zhao。
代码中需要使用变量参数时,通过argpaser对象的parser_args()函数来获取所有参数args,然后通过args.name的方式得到name参数的值。
ArgumentParser
创建对象。
本部分参考CSDN博客 Quant_Learner的文章 .
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() 所返回对象上的属性名。 |
args分为可选参数(用--指定)和必选参数(不加--指定)。
如果定义参数xxx时,没有用--指定,那么该参数为需要在命令行内手动指定。此时即使通过default设置默认参数,也还是会报错。
???
nargs=2的时候,命令行如何输入两个参数给一个变量呢?
parse_known_args()
参考官网 ArgumentParser.parse_known_args .
ArgumentParser.parse_known_args(args=None, namespace=None)
Sometimes a script may only parse a few of the command-line arguments, passing the remaining arguments on to another script or program. In these cases, the parse_known_args() method can be useful. It works much like parse_args() except that it does not produce an error when extra arguments are present. Instead, it returns a two item tuple containing the populated namespace and the list of remaining argument strings.
该函数很像parse_args(),但是其在接受到多余的命令行参数时不报错。相反地,返回一个tuple类型的命名空间和一个保存着余下的命令行字符的list。