【转】python argparse用法总结

转自：https://www.jianshu.com/p/fef2d215b91d

1. argparse介绍

是python的一个命令行解析包，非常编写可读性非常好的程序

2. 基本用法

prog.py是我在linux下测试argparse的文件，放在/tmp目录下，其内容如下：

#!/usr/bin/env python
# encoding: utf-8

import argparse
parser = argparse.ArgumentParser()
parser.parse_args()

测试：

[email protected] /tmp $ python prog.py 

[email protected] /tmp $ python prog.py --help
usage: prog.py [-h]

optional arguments:
  -h, --help  show this help message and exit

[email protected] /tmp $ python prog.py -v
usage: prog.py [-h]
prog.py: error: unrecognized arguments: -v

[email protected] /tmp $ python prog.py foo
usage: prog.py [-h]
prog.py: error: unrecognized arguments: foo
  • 第一个没有任何输出和出错
  • 第二个测试为打印帮助信息，argparse会自动生成帮助文档
  • 第三个测试为未定义的-v参数，会出错
  • 第四个测试为未定义的参数foo，出错

3. positional arguments

positional arguments为英文定义，中文名叫有翻译为定位参数的，用法是不用带-就可用
修改prog.py的内容如下：

#!/usr/bin/env python
# encoding: utf-8

import argparse

parser = argparse.ArgumentParser()
parser.add_argument("echo")
args = parser.parse_args()
print args.echo

执行测试如下

[email protected] /tmp $ python prog.py
usage: prog.py [-h] echo
prog.py: error: too few arguments

[email protected] /tmp $ python prog.py -h
usage: prog.py [-h] echo

positional arguments:
  echo

optional arguments:
  -h, --help  show this help message and exit

[email protected] /tmp $ python prog.py hahahaha
hahahaha

定义了一个叫echo的参数，默认必选

  • 第一个测试为不带参数，由于echo参数为空，所以报错，并给出用法（usage）和错误信息
  • 第二个测试为打印帮助信息
  • 第三个测试为正常用法，回显了输入字符串hahahaha

4. optional arguments

中文名叫可选参数，有两种方式：

  1. 一种是通过一个-来指定的短参数，如-h；
  2. 一种是通过--来指定的长参数，如--help

这两种方式可以同存，也可以只存在一个，修改prog.py内容如下：

#!/usr/bin/env python
# encoding: utf-8

import argparse

parser = argparse.ArgumentParser()
parser.add_argument("-v", "--verbosity", help="increase output verbosity")
args = parser.parse_args()
if args.verbosity:
        print "verbosity turned on"

注意这一行：parser.add_argument("-v", "--verbosity", help="increase output verbosity")
定义了可选参数-v或--verbosity，通过解析后，其值保存在args.verbosity变量中
用法如下：

[email protected] /tmp $ python prog.py -v 1
verbosity turned on

[email protected] /tmp $ python prog.py --verbosity 1
verbosity turned on

[email protected] /tmp $ python prog.py -h
usage: prog.py [-h] [-v VERBOSITY]

optional arguments:
  -h, --help            show this help message and exit
  -v VERBOSITY, --verbosity VERBOSITY
                        increase output verbosity

[email protected] /tmp $ python prog.py -v
usage: prog.py [-h] [-v VERBOSITY]
prog.py: error: argument -v/--verbosity: expected one argument
  • 测试1中，通过-v来指定参数值
  • 测试2中，通过--verbosity来指定参数值
  • 测试3中，通过-h来打印帮助信息
  • 测试4中，没有给-v指定参数值，所以会报错

5. action=‘store_true‘

上一个用法中-v必须指定参数值，否则就会报错，有没有像-h那样，不需要指定参数值的呢，答案是有，通过定义参数时指定action="store_true"即可，用法如下

#!/usr/bin/env python
# encoding: utf-8

import argparse

parser = argparse.ArgumentParser()
parser.add_argument("-v", "--verbose", help="increase output verbosity",
                    action="store_true")
args = parser.parse_args()
if args.verbose:
        print "verbosity turned on"

测试：

[email protected] /tmp $ python prog.py -v
verbosity turned on

[email protected] /tmp $ python prog.py -h
usage: prog.py [-h] [-v]

optional arguments:
  -h, --help     show this help message and exit
  -v, --verbose  increase output verbosity

第一个例子中，-v没有指定任何参数也可，其实存的是True和False，如果出现，则其值为True，否则为False

6. 类型 type

默认的参数类型为str，如果要进行数学计算，需要对参数进行解析后进行类型转换，如果不能转换则需要报错，这样比较麻烦
argparse提供了对参数类型的解析，如果类型不符合，则直接报错。如下是对参数进行平方计算的程序：

#!/usr/bin/env python
# encoding: utf-8

import argparse

parser = argparse.ArgumentParser()
parser.add_argument(‘x‘, type=int, help="the base")
args = parser.parse_args()
answer = args.x ** 2
print answer

测试

[email protected] /tmp $ python prog.py 2
4

[email protected] /tmp $ python prog.py two
usage: prog.py [-h] x
prog.py: error: argument x: invalid int value: ‘two‘

[email protected] /tmp $ python prog.py -h
usage: prog.py [-h] x

positional arguments:
  x           the base

optional arguments:
  -h, --help  show this help message and exit
  • 第一个测试为计算2的平方数，类型为int，正常
  • 第二个测试为一个非int数，报错
  • 第三个为打印帮助信息

7. 可选值choices=[]

5中的action的例子中定义了默认值为True和False的方式，如果要限定某个值的取值范围，比如6中的整形，限定其取值范围为0， 1， 2，该如何进行呢？
修改prog.py文件如下：

#!/usr/bin/env python
# encoding: utf-8

import argparse

parser = argparse.ArgumentParser()
parser.add_argument("square", type=int,
                    help="display a square of a given number")
parser.add_argument("-v", "--verbosity", type=int, choices=[0, 1, 2],
                    help="increase output verbosity")
args = parser.parse_args()
answer = args.square**2
if args.verbosity == 2:
    print "the square of {} equals {}".format(args.square, answer)
elif args.verbosity == 1:
    print "{}^2 == {}".format(args.square, answer)
else:
    print answer

测试如下：

[email protected] /tmp $ python prog.py 4 -v 0
16
[email protected] /tmp $ python prog.py 4 -v 1
4^2 == 16
[email protected] /tmp $ python prog.py 4 -v 2
the square of 4 equals 16
[email protected] /tmp $ python prog.py 4 -v 3
usage: prog.py [-h] [-v {0,1,2}] square
prog.py: error: argument -v/--verbosity: invalid choice: 3 (choose from 0, 1, 2)
[email protected] /tmp $ python prog.py -h
usage: prog.py [-h] [-v {0,1,2}] square

positional arguments:
  square                display a square of a given number

optional arguments:
  -h, --help            show this help message and exit
  -v {0,1,2}, --verbosity {0,1,2}
                        increase output verbosity
  • 测试1， 2， 3 为可选值范围，通过其值，打印不同的格式输出；
  • 测试4的verbosity值不在可选值范围内，打印错误
  • 测试5打印帮助信息

8. 自定义帮助信息help

上面很多例子中都为help赋值，如
parser.add_argument("square", type=int, help="display a square of a given number")
在打印输出时，会有如下内容

positional arguments:
  square                display a square of a given number

也就是help为什么，打印输出时，就会显示什么

9. 程序用法帮助

8中介绍了为每个参数定义帮助文档，那么给整个程序定义帮助文档该怎么进行呢？
通过argparse.ArgumentParser(description="calculate X to the power of Y")即可
修改prog.py内容如下：

#!/usr/bin/env python
# encoding: utf-8

import argparse

parser = argparse.ArgumentParser(description="calculate X to the power of Y")
group = parser.add_mutually_exclusive_group()
group.add_argument("-v", "--verbose", action="store_true")
group.add_argument("-q", "--quiet", action="store_true")
parser.add_argument("x", type=int, help="the base")
parser.add_argument("y", type=int, help="the exponent")
args = parser.parse_args()
answer = args.x**args.y

if args.quiet:
    print answer
elif args.verbose:
    print "{} to the power {} equals {}".format(args.x, args.y, answer)
else:
    print "{}^{} == {}".format(args.x, args.y, answer)

打印帮助信息时即显示calculate X to the power of Y

[email protected] /tmp $ python prog.py -h
usage: prog.py [-h] [-v | -q] x y

calculate X to the power of Y

positional arguments:
  x              the base
  y              the exponent

optional arguments:
  -h, --help     show this help message and exit
  -v, --verbose
  -q, --quiet

10. 互斥参数

在上个例子中介绍了互斥的参数

group = parser.add_mutually_exclusive_group()
group.add_argument("-v", "--verbose", action="store_true")
group.add_argument("-q", "--quiet", action="store_true")

第一行定义了一个互斥组，第二、三行在互斥组中添加了-v和-q两个参数，用上个例子中的程序进行如下测试：

[email protected] /tmp $ python prog.py 4 2
4^2 == 16
[email protected] /tmp $ python prog.py 4 2 -v
4 to the power 2 equals 16
[email protected] /tmp $ python prog.py 4 2 -q
16
[email protected] /tmp $ python prog.py 4 2 -q -v

可以看出，-q和-v不出现，或仅出现一个都可以，同时出现就会报错。
可定义多个互斥组

11.参数默认值

介绍了这么多，有没有参数默认值该如何定义呢？
修改prog.py内容如下：

#!/usr/bin/env python
# encoding: utf-8

import argparse

parser = argparse.ArgumentParser(description="calculate X to the power of Y")
parser.add_argument("square", type=int,
                    help="display a square of a given number")
parser.add_argument("-v", "--verbosity", type=int, choices=[0, 1, 2], default=1,
                    help="increase output verbosity")
args = parser.parse_args()
answer = args.square**2
if args.verbosity == 2:
    print "the square of {} equals {}".format(args.square, answer)
elif args.verbosity == 1:
    print "{}^2 == {}".format(args.square, answer)
else:
    print answer

测试结果如下

[email protected] /tmp $ python prog.py 8
8^2 == 64
[email protected] /tmp $ python prog.py 8 -v 0
64
[email protected] /tmp $ python prog.py 8 -v 1
8^2 == 64
[email protected] /tmp $ python prog.py 8 -v 2
the square of 8 equals 64

可以看到如果不指定-v的值，args.verbosity的值默认为1，为了更清楚的看到默认值，也可以直接打印进行测试。

原文地址：https://www.cnblogs.com/yoyo008/p/10294456.html

时间： 2024-10-09 16:51:11

【转】python argparse用法总结的相关文章

python argparse用法总结

转:python argparse用法总结 1. argparse介绍 argparse是python的一个命令行解析包,非常编写可读性非常好的程序 2. 基本用法 prog.py是我在linux下测试argparse的文件,放在/tmp目录下,其内容如下: #!/usr/bin/env python # encoding: utf-8 import argparse parser = argparse.ArgumentParser() parser.parse_args() 测试: [emai

python argparse用法

示例一 创建文件prog.py import argparse parser = argparse.ArgumentParser() parser.add_argument("echo") args = parser.parse_args() print(args.echo) 执行结果: $ python3 prog.py usage: prog.py [-h] echo prog.py: error: the following arguments are required: ech

python argparse模块

python argparse 模块的功能是对命令行进行解析,检查命令行是否符合预定义的格式. 使用方法: 1.导入argparse模块   import argparse 2.创建argparse对象   parser = argparse.ArgumentParser() 3.添加命令行相关参数.选项  parser.add_argument("...") 4.解析    parser.parse_args() 例一:(删除指定的zabbix screen) #!/usr/bin/

Python Dict用法

Operation Result len(a) the number of items in a 得到字典中元素的个数 a[k] the item of a with key k 取得键K所对应的值 a[k] = v set a[k] to v 设定键k所对应的值成为v del a[k] remove a[k] from a 从字典中删除键为k的元素 a.clear() remove all items from a 清空整个字典 a.copy() a (shallow) copy of a 得

学习python argparse模块下载安装和使用

Python中argparse模块已经替代以前的optparse模块,常被用来实现命令行参数和选项的解析作用. 位置参数: 从一个最基本的程序开始(它并没有实现什么现实的功能): import argparseparser = argparse.ArgumentParser()parser.parse_args() 下面是运行之后的结果: $ python prog.py$ python prog.py --helpusage: prog.py [-h]optional arguments: 

python with用法

@python with用法 python中with可以明显改进代码友好度,比如: [python] view plaincopyprint? with open('a.txt') as f: print f.readlines() 为了我们自己的类也可以使用with, 只要给这个类增加两个函数__enter__, __exit__即可: [python] view plaincopyprint? >>> class A: def __enter__(self): print 'in e

（转）python set 用法

转载自:http://hi.baidu.com/????_xu/blog/item/5b9650c513bd3f049d163d8b .html python的set和其他语言类似, 是一个 基本功能包括关系测试和消除重复元素. 集合对象还支持union(联合), intersection(交), difference(差)和sysmmetric difference(对称差集)等数学运算. >>> basket = [’apple’, ’orange’, ’apple’, ’pear’

Python高级用法总结

Python很棒,它有很多高级用法值得细细思索,学习使用.本文将根据日常使用,总结介绍Python的一组高级特性,包括:列表推导式.迭代器和生成器.装饰器. 列表推导(list comprehensions) 场景1:将一个三维列表中所有一维数据为a的元素合并,组成新的二维列表. 最简单的方法:新建列表,遍历原三维列表,判断一维数据是否为a,若为a,则将该元素append至新列表中. 缺点:代码太繁琐,对于Python而言,执行速度会变慢很多. 针对场景1,我们首先应该想到用列表解析式来解决处理

Python多重继承用法 Python周末学习

Python多重继承用法 Python周末学习 继承是面向对象编程的一个重要方式,通过继承,子类可以扩展父类的功能,Python也具有该特性,除此之外,Python还可以使用多重继承. 语法: class subClass(Base1,Base2) 该语法的含义是创建了一个subClass类,让它同时继承了Base1和Base2的相关特性,关于继承还有以下规则需要遵循: 1. 继承只会继承父类的方法,不能继承父类的变量: 2. 要想继承父类的变量,需要执行父类的__init__(self)方法: