Python 内置模块之 argparse - 解析命令行参数

官方文档：https://docs.python.org/zh-cn/3.8/library/argparse.html

python 命令行参数（sys.argv）

有时候我们需要写一些脚本处理一些任务，这时候往往需要提供一些命令行参数，根据不同参数进行不同的处理，在 Python 里，命令行的参数和 C 语言很类似（因为标准 Python 是用 C 语言实现的）。在 C 语言里，main 函数的原型为 int main(int argc, char **argv)，这里主要指 linux 平台，argc 指的是命令行传入的参数个数（程序的 name 为第一个参数），而 argv 则是一个指针数组，每一个元素为指向一个命令行参数的指针。在 Python 里的命令行参数是存储在 sys.argv 里，argv 是一个列表，第一个元素也为程序名称。

import sys

for i in sys.argv:
    print(i)

argparse 模块

argparse 是 Python 内置的一个用于命令项选项与参数解析的模块，通过在程序中定义好我们需要的参数，argparse 将会从 sys.argv 中解析出这些参数，并自动生成帮助和使用信息。当然，Python 也有第三方的库可用于命令行解析，而且功能也更加强大，比如 docopt，Click。

1. 命令行参数分为位置参数和选项参数

• 位置参数就是程序根据该参数出现的位置来确定的
  • 如：ls root/。其中 root/ 是位置参数
• 选项参数是应用程序已经提前定义好的参数，不是随意指定的
  • 如：ls -l。-l 就是 ls 命令里的一个选项参数

2. 简单示例：

import argparse
 
parser = argparse.ArgumentParser()  # 创建一个解析对象  
parser.add_argument()               # 向该对象中添加你要关注的命令行参数和选项  
parser.parse_args()                 # 进行解析

3. argparse.ArgumentParser()

作用：实例化

方法：

description：命令行帮助的开始文字，**大部分情况下，我们只会用到这个参数**
epilog：命令行帮助的结尾文字
prog：(default: sys.argv[0]) 程序的名字，一般不需要修改，另外，如果你需要在 help 中使用到程序的名字，可以使用 %(prog)s
prefix_chars：命令的前缀，默认是-，例如 -f/-file。有些程序可能希望支持 /f 这样的选项，可以使用 prefix_chars="/"
fromfile_prefix_chars： (default: None)如果你希望命令行参数可以从文件中读取，就可能用到。例如，如果 fromfile_prefix_chars="@", 命令行参数中有一个为 "@args.txt"，args.txt 的内容会作为命令行参数
add_help：是否增加 -h/-help 选项 (default: True)，一般 help 信息都是必须的，所以不用设置啦。
parents：类型是 list，如果这个 parser 的一些选项跟其他某些 parser 的选项一样，可以用 parents 来实现继承，例如 parents=[parent_parser]
     三个允许的值： 
        # class argparse.RawDescriptionHelpFormatter 直接输出description和epilog的原始形式（不进行自动换行和消除空白的操作） 
        # class argparse.RawTextHelpFormatter 直接输出description和epilog以及add_argument中的help字符串的原始形式（不进行自动换行和消除空白的操作） 
        # class argparse.ArgumentDefaultsHelpFormatter 在每个选项的帮助信息后面输出他们对应的缺省值，如果有设置的话。这个最常用吧！
argument_default：(default: None) 设置一个全局的选项的缺省值，一般每个选项单独设置，所以这个参数用得少，不细说
usage：(default: generated) 如果你需要修改 usage 的信息（usage: PROG [-h] [-foo [FOO]] bar [bar …]），那么可以修改这个，一般不要修改。
conflict_handler：不建议使用。这个在极端情况下才会用到，主要是定义两个 add_argument 中添加的选项的名字发生冲突时怎么处理，默认处理是抛出异常。

4. add_argument()

作用：给 ArgumentParser 对象添加新的命令行参数，参数的类型和相应的处理方法由不同的参数决定。

语法：

1.  name or flags: 指定参数的形式，想写几个写几个，不过我们一般就写两个，一个短参数，一个长参数，看下面的例子 "-f", "-file"
    可选的选项，位置不固定，想怎么写就怎么写，默认是可选的 # parser.add_argument("-f", "-file", help="test test test")
    位置固定的选项，例如 "prog i_am_bar"，这样子的话，i_am_bar 就是bar选项的值啦，默认是必须有的 # parser.add_argument("bar", help="test test test")

2.  nargs: 指定这个参数后面的 value 有多少个，例如，我们希望使用 -n 1 2 3 4，来设置n的值为[1, 2, 3, 4] #parser.add_argument("-n", "-num", nargs="+", type=int) # 这里nargs="+"表示，如果你指定了-n选项，那么-n后面至少要跟一个参数，+表示至少一个,?表示一个或0个,0个或多个 。

3.  default: 如果命令行没有出现这个选项，那么使用default指定的默认值 #parser.add_argument("+g", "++gold", help="test test test",default="test_gold")#需要prefix_chars包含"+" 。

4.  type: 如果希望传进来的参数是指定的类型（例如 float, int or file等可以从字符串转化过来的类型），可以使用 #parser.add_argument("-x", type=int) 。

5.  choices: 设置参数值的范围，如果choices中的类型不是字符串，记得指定type哦 #parser.add_argument("-y", choices=["a", "b", "d"])

6.  required: 通常-f这样的选项是可选的，但是如果required=True那么就是必须的了 #parser.add_argument("-z", choices=["a", "b", "d"], required=True)

7.  metavar: 参数的名字，在显示 帮助信息时才用到. # parser.add_argument("-o", metavar="OOOOOO")

8.  help: 设置这个选项的帮助信息

9.  dest: 设置这个选项的值就是解析出来后放到哪个属性中 #parser.add_argument("-q", dest="world")

示例

import argparse
parser = argparse.ArgumentParser(description = 'this is a description')
parser.add_argument('--ver', '-v', action = 'store_true', help = 'hahaha')
# 将变量以标签-值的字典形式存入args字典,键为参数的全称，不是简写
args = parser.parse_args()
if args.ver:
    print("Ture")
else:
    print("False")


# required标签就是说--ver参数是必需的，并且类型为int，输入其它类型会报错
parser.add_argument('--ver', '-v', required = True, type = int)

parser.add_argument('file', choices = ['test1', 'test2'])
args = parser.parse_args()
print('read in %s'%(args.file))

# 表示脚本可以读入两个整数赋予num键（此时的值为2个整数的数组）
parser.add_argument('filename', nargs = 2, type = int)
args = parser.parse_args()
print('read in %s'%(args.filename))


# nargs还可以"\*"用来表示如果有该位置参数输入的话，之后所有的输入都将作为该位置参数的值；"+"表示读取至少1个该位置参数。"?'表示该位置参数要么没有，要么就只要一个。（PS：跟正则表达式的符号用途一致。）  
parser.add_argument('filename', nargs = '+', type = int)
args = parser.parse_args()
print('read in %s'%(args.filename))


# dest - 设置这个选项的value解析出来后放到哪个属性中
parser.add_argument('-file', choices = ['test1', 'test2'], dest = 'world')
args = parser.parse_args()
print('read in %s'%(args.world))

5.parse_args(args=None, namespace=None)

parse_args() 方法将命令行参数字符串转换为相应对象并赋值给 Namespace 对象的相应属性，默认返回一个 Namespace 对象。