前言

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:\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'

示例二:整数求和

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

#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:\Users\Tony>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:\Users\Tony>python p.py 1 33 5 6
33

C:\Users\Tony>python p.py -sum 1 33 5 6

C:\Users\Tony>python p.py 1 33 5 6 --sum
45

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

C:\Users\Tony>python p.py
#需要输入值N
usage: p.py [-h] [--sum] N [N ...]
p.py: error: the following arguments are required: N

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"文档(内容一样)

#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:\Users\Tony>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:\Users\Tony>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:\Users\Tony>python d.py 3
usage: d.py [-h] hi
d.py: error: argument hi: '3' 不是一个完全平方数

C:\Users\Tony>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:\Users\Tony>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:\Users\Tony>python s.py add --x 11 --y 2 --z 9
x y z= 22

到此这篇关于Python详解argparse参数模块之命令行参数的文章就介绍到这了,更多相关Python argparse 内容请搜索Devmax以前的文章或继续浏览下面的相关文章希望大家以后多多支持Devmax!

Python详解argparse参数模块之命令行参数的更多相关文章

  1. XCode 3.2 Ruby和Python模板

    在xcode3.2下,我的ObjectiveCPython/Ruby项目仍然可以打开更新和编译,但是你无法创建新项目.鉴于xcode3.2中缺少ruby和python的所有痕迹(即创建项目并添加新的ruby/python文件),是否有一种简单的方法可以再次安装模板?我发现了一些关于将它们复制到某个文件夹的信息,但我似乎无法让它工作,我怀疑文件夹的位置已经改变为3.2.解决方法3.2中的应用程序模板

  2. Swift基本使用-函数和闭包(三)

    声明函数和其他脚本语言有相似的地方,比较明显的地方是声明函数的关键字swift也出现了Python中的组元,可以通过一个组元返回多个值。传递可变参数,函数以数组的形式获取参数swift中函数可以嵌套,被嵌套的函数可以访问外部函数的变量。可以通过函数的潜逃来重构过长或者太复杂的函数。

  3. 10 个Python中Pip的使用技巧分享

    众所周知,pip 可以安装、更新、卸载 Python 的第三方库,非常方便。本文小编为大家总结了Python中Pip的使用技巧,需要的可以参考一下

  4. Swift、Go、Julia与R能否挑战 Python 的王者地位

    本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容,请发送邮件至dio@foxmail.com举报,一经查实,本站将立刻删除。

  5. 红薯因 Swift 重写开源中国失败,貌似欲改用 Python

    本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容,请发送邮件至dio@foxmail.com举报,一经查实,本站将立刻删除。

  6. 你没看错:Swift可以直接调用Python函数库

    上周Perfect又推出了新一轮服务器端Swift增强函数库:Perfect-Python。对,你没看错,在服务器端Swift其实可以轻松从其他语种的函数库中直接拿来调用,不需要修改任何内容。以如下python脚本为例:Perfect-Python可以用下列方法封装并调用以上函数,您所需要注意的仅仅是其函数名称以及参数。

  7. Swift中的列表解析

    在Swift中完成这个的最简单的方法是什么?我在寻找类似的东西:从Swift2.x开始,有一些与你的Python样式列表解析相当的东西。(在这个意义上,它更像是Python的xrange。如果你想保持集合懒惰一路通过,只是这样说:与Python中的列表解析语法不同,Swift中的这些操作遵循与其他操作相同的语法。

  8. swift抛出终端的python错误

    每当我尝试启动与python相关的swift时,我都会收到错误.我该如何解决?

  9. 在Android上用Java嵌入Python

    解决方法看看this,它适用于J2SE,你可以尝试在Android上运行.

  10. 在android studio中使用python代码构建android应用程序

    我有一些python代码和它的机器人,我正在寻找一种方法来使用android项目中的那些python代码.有没有办法做到这一点!?解决方法有两种主要工具可供使用,它们彼此不同:>QPython>Kivy使用Kivy,大致相同的代码也可以部署到IOS.

随机推荐

  1. 10 个Python中Pip的使用技巧分享

    众所周知,pip 可以安装、更新、卸载 Python 的第三方库,非常方便。本文小编为大家总结了Python中Pip的使用技巧,需要的可以参考一下

  2. python数学建模之三大模型与十大常用算法详情

    这篇文章主要介绍了python数学建模之三大模型与十大常用算法详情,文章围绕主题展开详细的内容介绍,具有一定的参考价值,感想取得小伙伴可以参考一下

  3. Python爬取奶茶店数据分析哪家最好喝以及性价比

    这篇文章主要介绍了用Python告诉你奶茶哪家最好喝性价比最高,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习吧

  4. 使用pyinstaller打包.exe文件的详细教程

    PyInstaller是一个跨平台的Python应用打包工具,能够把 Python 脚本及其所在的 Python 解释器打包成可执行文件,下面这篇文章主要给大家介绍了关于使用pyinstaller打包.exe文件的相关资料,需要的朋友可以参考下

  5. 基于Python实现射击小游戏的制作

    这篇文章主要介绍了如何利用Python制作一个自己专属的第一人称射击小游戏,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起动手试一试

  6. Python list append方法之给列表追加元素

    这篇文章主要介绍了Python list append方法如何给列表追加元素,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教

  7. Pytest+Request+Allure+Jenkins实现接口自动化

    这篇文章介绍了Pytest+Request+Allure+Jenkins实现接口自动化的方法,文中通过示例代码介绍的非常详细。对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下

  8. 利用python实现简单的情感分析实例教程

    商品评论挖掘、电影推荐、股市预测……情感分析大有用武之地,下面这篇文章主要给大家介绍了关于利用python实现简单的情感分析的相关资料,文中通过示例代码介绍的非常详细,需要的朋友可以参考下

  9. 利用Python上传日志并监控告警的方法详解

    这篇文章将详细为大家介绍如何通过阿里云日志服务搭建一套通过Python上传日志、配置日志告警的监控服务,感兴趣的小伙伴可以了解一下

  10. Pycharm中运行程序在Python console中执行,不是直接Run问题

    这篇文章主要介绍了Pycharm中运行程序在Python console中执行,不是直接Run问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教

返回
顶部