Python详解argparse参数模块之命令行参数

　　小编给大家写这篇文章的主要目的，就是给大家详细解答，python中的argparse参数模块的相关知识解答。

　　前言

　　help(argparse)查看说明文档，“argparse-Command-line parsing library”我们可以知道是一个命令行解析库，是关于参数解析相关的一个模块。

　　示例一：最简参数对象

　　先来一段简单的代码，快速熟知下这个参数是个啥。

　　保存为t.py这样一个文件

　  import argparse
　　parser=argparse.ArgumentParser(description='最简单的测试')
　　parser.add_argument('--test',type=str,default='China')
　　args=parser.parse_args()
　　print(args.test)

　　然后我们在命令行中运行这个文件

　　C:UsersTony>python t.py--test"I love China"

　　I love China

　　我们来分析下这段代码，首先就是创建一个参数解析对象赋给parser，然后在parser对象中使用add_argument方法添加参数以及各种选项，其中--test就是参数，这个参数的名称依其作用自定义，type=str指定输入值类型为字符串，default='China'是默认值，就是说如果不指定参数，就显示China这个默认值

　　对于parser.parse_args()解析参数之后的调用，需要说明下，如果没有指定dest，那就是直接调用去掉短横线的名称，如果指定了，比如dest='showstr'，那么就调用args.showstr属性，如果还是调用test就会报错，需要修改为print(args.showstr)

　　AttributeError:'Namespace'object has no attribute'test'

　　示例二：整数求和

　　若没有指定参数就取这些整数当中的最大值：

　  #p.py
　　import argparse
　　#创建ArgumentParser对象，用来解析
　　parser=argparse.ArgumentParser(description='处理一些整数')
　　#向对象添加参数
　　parser.add_argument('integers',metavar='N',type=int,nargs='+',help='累加的整数')
　　parser.add_argument('--sum',dest='accumulate',action='store_const',const=sum,default=max,help='求和(默认求最大值)')
　　#解析参数
　　args=parser.parse_args()
　　print(args.accumulate(args.integers))

　　其中调用parse_args()方法时，将返回两个参数属性(integers和accumulate)，integers属性是一个或多个的整数，accumulate属性是sum()求和函数，如果没有--sum参数的话就是默认max()最大值函数，default=max

　　另外N可以指定个数，nargs='+'，表示一个或多个，对正则表达式熟悉的那就很简单了，是一个通配符，另外还有'?'表示一个，'*'表示0个或多个。

　print(parser.parse_args(['--sum','1','33','5','6']))
　　'''
　　Namespace(accumulate=<built-in function sum>,integers=[1,33,5,6])
　　'''

　　我们可以看到出现一个命名空间，其中accumulate属性是一个sum方法，integers属性是一系列的整数。

　　可以查看使用帮助说明：

　　C:UsersTony>python p.py-h

　　usage:p.py[-h][--sum]N[N...]

　　处理一些整数

　　positional arguments:

　　N累加的整数

　　optional arguments:

　　-h,--help show this help message and exit

　　--sum求和(默认求最大值)

　　带参与不带参的操作：

　　当然如果是没有按照参数设定的情况，会报错：

　　C:UsersTony>python p.py

　　#需要输入值N

　　usage:p.py[-h][--sum]N[N...]

　　p.py:error:the following arguments are required:N

　　C:UsersTony>python p.py 1 33 5.1 6

　　#需要输入整数，浮点数就报错

　　usage:p.py[-h][--sum]N[N...]

　　p.py:error:argument N:invalid int value:'5.1'

　　可以看出这个参数对象除了可以在命令行界面方便使用之外，还可以对其做一些严格的限定。比如类型的限定，示例二的类型指定为int，那就不能是浮点数，如果可以是浮点数就指定成type=float

　　示例三：文件是否被篡改

　　我们来看下，test目录下面(放了三个文本文件）,生成每个文件的md5值，如果和官网提供的md5一样就说明内容没有被篡改，执行完之后将显示每个文件生成的MD5值以及生成一个名为"目录后缀.txt"文档（内容一样）

　　#m.py
　　import os
　　from hashlib import md5
　　import argparse
　　def parse_args():
　　parser=argparse.ArgumentParser()
　　parser.add_argument('--file_dir',type=str)
　　return parser.parse_args()
　　def generate_md5(file_path):
　　m=md5()
　　file=open(file_path,'rb')
　　f=file.read()
　　m.update(f)
　　file.close()
　　return m.hexdigest()
　　if __name__=='__main__':
　　args=parse_args()
　　file_dir=args.file_dir
　　log_path=args.file_dir+'.txt'
　　log=open(log_path,'w+')
　　for root,_,files in os.walk(file_dir):
　　for file in files:
　　file_path=os.path.join(root,file)
　　md5_value=generate_md5(file_path)
　　print(file+":"+md5_value)
　　log.write(file+":"+md5_value+'n')

　　命令行执行：

　　C:UsersTony>python m.py--file_dir"C:/Users/Tony/test"

　　1.txt:81dc9bdb52d04dc20036dbd8313ed055

　　2.txt:d84b0391f5ce6b011e4086ed73d9dd9b

　　3.txt:2b3b15ac34d69fa01e851d483e61f029

　　这段代码可以看出，只需指定一个文件目录的参数即可求出目录下面所有文件的md5值。当然也可以跟示例二那样做一些说明：parser.add_argument('--file_dir',type=str,help='指定文件所在目录')加一个help参数的说明文字。

　　C:UsersTony>python m.py-h

　　usage:m.py[-h][--file_dir FILE_DIR]

　　optional arguments:

　　-h,--help show this help message and exit

　　--file_dir FILE_DIR指定文件所在目录

　parser=argparse.ArgumentParser('对文件批量生成MD5值')
　　parser.add_argument('--file_dir',dest='fdir',type=str,help='指定文件所在目录')
　　print(parser.print_help())
　　'''
　　usage:对文件批量生成MD5值[-h][--file_dir FDIR]
　　optional arguments:
　　-h,--help show this help message and exit
　　--file_dir FDIR指定文件所在目录
　　None
　　'''

　　自定义类型

　　除了基本类型之外，还可以自定义类型，如下定义一个类型只能是完全平方数的值

　　#d.py
　　import argparse
　　import math
　　def perfect_square(s):
　　v=int(s)
　　vs=math.sqrt(v)
　　if vs!=int(vs):
　　msg="%r不是一个完全平方数"%s
　　raise argparse.ArgumentTypeError(msg)
　　return v
　　parser=argparse.ArgumentParser(description='自定义类型')
　　parser.add_argument('hi',type=perfect_square,help='只能是完全平方数')
　　args=parser.parse_args()
　　print(args.hi)
　　命令行运行：
　　C:UsersTony>python d.py 3
　　usage:d.py[-h]hi
　　d.py:error:argument hi:'3'不是一个完全平方数
　　C:UsersTony>python d.py-h
　　usage:d.py[-h]hi

　　自定义类型：

　　positional arguments:

　　hi只能是完全平方数

　　optional arguments:

　　-h,--help show this help message and exit

　　可以看到hi参数是一个positional arguments(位置参数)，也就是说是必须的，不像前面有短横线的optional arguments(可选参数)

　　choices选项限定

　　除了上述类型限定和可以自定义类型之外，还可以限定在一些自定义的范围内

　　#c.py
　　parser=argparse.ArgumentParser(description='自定义选项')
　　parser.add_argument('sel',type=int,choices=range(1,9),help='请输入[1-9)范围的整数')
　　args=parser.parse_args()
　　print(args.sel)

　　命令行执行：

　　C:UsersTony>python c.py 10

　　usage:c.py[-h]{1,2,3,4,5,6,7,8}

　　c.py:error:argument sel:invalid choice:10(choose from 1,2,3,4,5,6,7,8)

　　required必选参数

　　我们也可以对可选参数指定为必选，不指定的情况：

　parser=argparse.ArgumentParser(description='自定义选项')
　　parser.add_argument('--sel',type=int,choices=range(1,9),help='请输入[1-9)范围的整数')
　　print(parser.parse_args([]))

　　这个例子，我们知道sel参数是可选的，这样不会出错，结果：Namespace(sel=None)

　　如果加一个required=True

　　parser.add_argument('--sel',required=True,type=int,choices=range(1,9),help='请输入[1-9)范围的整数')

　　#执行就会报错：

　　usage:ipykernel_launcher.py[-h]--sel{1,2,3,4,5,6,7,8}

　　ipykernel_launcher.py:error:the following arguments are required:--sel

　　An exception has occurred,use%tb to see the full traceback.

　　#这个时候的参数sel就是必选参数了

　　print(parser.parse_args(['--sel','2']))

　　Namespace(sel=2)

　　子命令

　　主要是set_defaults方法的用途，在多个解析器的时候显得很重要。

　　#s.py
　　def f(v):
　　r=v.x+v.y+v.z
　　print('x+y+z=',r)
　　parser=argparse.ArgumentParser(description='求三个输入值的和')
　　subparsers=parser.add_subparsers(help='子命令的用法')
　　parser_a=subparsers.add_parser('add',help='加法运算')
　　parser_a.add_argument('--x',type=int)
　　parser_a.add_argument('--y',type=int)
　　parser_a.add_argument('--z',type=int)
　　parser_a.set_defaults(func=f)#parser_a设置默认函数为f
　　args=parser.parse_args()
　　args.func(args)#运行函数

　　命令行执行：

　　C:UsersTony>python s.py add--x 11--y 2--z 9

　　x+y+z=22

　　综上所述，argparse参数模块参数命令符就为大家介绍到这里了，希望可以为各位读者带来帮助。