请选择 进入手机版 | 继续访问电脑版
查看: 201|回复: 0

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

[复制链接]

2066

主题

2066

帖子

6594

积分

管理员

Rank: 9Rank: 9Rank: 9

积分
6594
发表于 2022-10-9 04:11:38 | 显示全部楼层 |阅读模式
前言

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

示例一:最简参数对象

先来一段简单的代码,快速熟知下这个参数是个啥。
生存为t.py这样一个文件
  1. import argparse
  2. parser = argparse.ArgumentParser(description='最简单的测试')
  3. parser.add_argument('--test', type=str, default='China')
  4. args = parser.parse_args()
  5. print(args.test)
复制代码
然后我们在命令行中运行这个文件
  1. C:\Users\Tony>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'

示例二:整数求和

若没有指定参数就取这些整数当中的最大值:
  1. #p.py
  2. import argparse
  3. #创建ArgumentParser对象,用来解析
  4. parser = argparse.ArgumentParser(description='处理一些整数')
  5. #向对象添加参数
  6. parser.add_argument('integers', metavar='N', type=int, nargs='+',help='累加的整数')
  7. parser.add_argument('--sum', dest='accumulate', action='store_const',const=sum, default=max,help='求和(默认求最大值)')
  8. #解析参数
  9. args = parser.parse_args()
  10. print(args.accumulate(args.integers))
复制代码
其中调用parse_args()方法时,将返回两个参数属性(integers和accumulate),integers属性是一个或多个的整数,accumulate属性是sum()求和函数,如果没有--sum参数的话就是默认max()最大值函数,default=max
另外N可以指定个数,nargs='+',表现一个或多个,对正则表达式熟悉的那就很简单了,是一个通配符,另外还有'?'表现一个,'*'表现0个或多个。
  1. print(parser.parse_args(['--sum','1','33','5','6']))
  2. '''
  3. Namespace(accumulate=<built-in function sum>, integers=[1, 33, 5, 6])
  4. '''
复制代码
我们可以看到出现一个命名空间,其中accumulate属性是一个sum方法, integers属性是一系列的整数。
可以检察使用资助说明:
  1. C:\Users\Tony>python p.py -h
  2. usage: p.py [-h] [--sum] N [N ...]
  3. 处理一些整数
  4. positional arguments:  N           累加的整数
  5. optional arguments:  -h, --help  show this help message and exit  --sum       求和(默认求最大值)
复制代码
带到场不带参的操纵:
  1. C:\Users\Tony>python p.py 1 33 5 633
  2. C:\Users\Tony>python p.py -sum 1 33 5 6或C:\Users\Tony>python p.py 1 33 5 6 --sum45
复制代码
当然如果是没有按照参数设定的情况,会报错:
  1. C:\Users\Tony>python p.py#需要输入值Nusage: p.py [-h] [--sum] N [N ...]p.py: error: the following arguments are required: N
  2. C:\Users\Tony>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"文档(内容一样)
  1. #m.py
  2. import os
  3. from hashlib import md5
  4. import argparse

  5. def parse_args():
  6.     parser =argparse.ArgumentParser()
  7.     parser.add_argument('--file_dir', type=str)
  8.     return parser.parse_args()
  9. def generate_md5(file_path):
  10.     m =md5()
  11.     file = open(file_path, 'rb')
  12.     f = file.read()
  13.     m.update(f)
  14.     file.close()
  15.     return m.hexdigest()

  16. if __name__ == '__main__':
  17.     args = parse_args()
  18.     file_dir = args.file_dir
  19.     log_path = args.file_dir + '.txt'
  20.     log = open(log_path, 'w+')
  21.     for root, _, files in os.walk(file_dir):
  22.         for file in files:
  23.             file_path = os.path.join(root, file)
  24.             md5_value = generate_md5(file_path)
  25.             print(file + " : " + md5_value)
  26.             log.write(file + " : " + md5_value + '\n')
复制代码
命令行执行:
  1. C:\Users\Tony>python m.py --file_dir "C:/Users/Tony/test"1.txt : 81dc9bdb52d04dc20036dbd8313ed0552.txt : d84b0391f5ce6b011e4086ed73d9dd9b3.txt : 2b3b15ac34d69fa01e851d483e61f029
复制代码
这段代码可以看出,只需指定一个文件目录的参数即可求出目录下面所有文件的md5值。当然也可以跟示例二那样做一些说明:parser.add_argument('--file_dir', type=str,help='指定文件所在目录') 加一个help参数的说明文字。
  1. C:\Users\Tony>python m.py -husage: m.py [-h] [--file_dir FILE_DIR]
  2. optional arguments:  -h, --help           show this help message and exit  --file_dir FILE_DIR  指定文件所在目录
复制代码
  1. parser = argparse.ArgumentParser('对文件批量生成MD5值')
  2. parser.add_argument('--file_dir',dest='fdir',type=str,help='指定文件所在目录')
  3. print(parser.print_help())
  4. '''
  5. usage: 对文件批量生成MD5值 [-h] [--file_dir FDIR]
  6. optional arguments:
  7.   -h, --help       show this help message and exit
  8.   --file_dir FDIR  指定文件所在目录
  9. None
  10. '''
复制代码
自定义类型

除了基本类型之外,还可以自定义类型,如下定义一个类型只能是完全平方数的值
  1. #d.py
  2. import argparse
  3. import math

  4. def perfect_square(s):
  5.     v=int(s)
  6.     vs=math.sqrt(v)
  7.     if vs!=int(vs):
  8.         msg="%r 不是一个完全平方数" %s
  9.         raise argparse.ArgumentTypeError(msg)
  10.     return v
  11. parser=argparse.ArgumentParser(description='自定义类型')
  12. parser.add_argument('hi',type=perfect_square,help='只能是完全平方数')
  13. args = parser.parse_args()
  14. print(args.hi)
复制代码
命令行运行:
  1. C:\Users\Tony>python d.py 3usage: d.py [-h] hid.py: error: argument hi: '3' 不是一个完全平方数
复制代码
  1. C:\Users\Tony>python d.py -husage: d.py [-h] hi
  2. <strong>自定义类型:</strong>
  3. positional arguments:  hi          只能是完全平方数
  4. optional arguments:  -h, --help  show this help message and exit
复制代码
可以看到hi参数是一个positional arguments(位置参数),也就是说是必须的,不像前面有短横线的optional arguments(可选参数)

choices选项限定

除了上述类型限定和可以自定义类型之外,还可以限定在一些自定义的范围内
  1. #c.py
  2. parser=argparse.ArgumentParser(description='自定义选项')
  3. parser.add_argument('sel',type=int,choices=range(1,9),help='请输入[1-9)范围的整数')
  4. args = parser.parse_args()
  5. print(args.sel)
复制代码
  1. <strong>命令行执行:</strong>C:\Users\Tony>python c.py 10usage: 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必选参数

我们也可以对可选参数指定为必选,不指定的情况:
  1. parser=argparse.ArgumentParser(description='自定义选项')
  2. parser.add_argument('--sel',type=int,choices=range(1,9),help='请输入[1-9)范围的整数')
  3. print(parser.parse_args([]))
复制代码
这个例子,我们知道sel参数是可选的,这样不会堕落,结果:Namespace(sel=None)
如果加一个required=True
  1. parser.add_argument('--sel',required=True,type=int,choices=range(1,9),help='请输入[1-9)范围的整数')
  2. #执行就会报错:
  3. usage: ipykernel_launcher.py [-h] --sel {1,2,3,4,5,6,7,8}
  4. ipykernel_launcher.py: error: the following arguments are required: --sel
  5. An exception has occurred, use %tb to see the full traceback.
  6. #这个时候的参数sel就是必选参数了
  7. print(parser.parse_args(['--sel','2']))
  8. Namespace(sel=2)
复制代码
子命令
  1. 主要是set_defaults方法的用途,在多个解析器的时候显得很重要。
  2. #s.py
  3. def f(v):
  4.      r=v.x + v.y + v.z
  5.      print('x+y+z=',r)
  6. parser = argparse.ArgumentParser(description='求三个输入值的和')
  7. subparsers = parser.add_subparsers(help='子命令的用法')
  8. parser_a = subparsers.add_parser('add', help='加法运算')
  9. parser_a.add_argument('--x', type=int)
  10. parser_a.add_argument('--y', type=int)
  11. parser_a.add_argument('--z', type=int)
  12. parser_a.set_defaults(func=f)#parser_a设置默认函数为f
  13. args = parser.parse_args()
  14. args.func(args)#运行函数
复制代码
命令行执行:
  1. C:\Users\Tony>python s.py add --x 11 --y 2 --z 9x+y+z= 22
复制代码
到此这篇关于Python详解argparse参数模块之命令行参数的文章就介绍到这了,更多相关Python argparse 内容请搜索趣UU以前的文章或继续浏览下面的相关文章希望大家以后多多支持趣UU!

免责声明:如果侵犯了您的权益,请联系站长,我们会及时删除侵权内容,谢谢合作!
打赏作者
  • 0
  • 0
  • 0
  • 0
回复

使用道具 举报

您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

快速回复 返回顶部 返回列表