python argparse (2)

python中的命令行解析最简单最原始的方法是使用sys.argv来实现,更高级的可以使用argparse这个模块。argparse从python 2.7开始被加入到标准库中,所以如果你的python版本还在2.7以下,那么需要先手动安装。

基本使用

import argparse
parser=argparse.ArgumentParser()
parser.add_argument("echo",help="echo the string")
args=parser.parse_args()
print args.echo

参数介绍

上面这个例子是最简单的一个使用例子,功能是把你的输入参数打印到屏幕 。不过对于基本的使用需求,这几行代码应该就已经够用,更加高级的用法可以参考官方文档。

下面介绍下例子代码。

1、导入argparse模块

2、创建解析器对象ArgumentParser,可以添加参数。

description:描述程序

parser=argparse.ArgumentParser(description="This is a example program ")

add_help:默认是True,可以设置False禁用

3、add_argument()方法,用来指定程序需要接受的命令参数

定位参数:

parser.add_argument("echo",help="echo the string")

可选参数:

parser.add_argument("--verbosity", help="increase output verbosity")

在执行程序的时候,定位参数必选,可选参数可选。

add_argument()常用的参数:

dest:如果提供dest,例如dest="a",那么可以通过args.a访问该参数

default:设置参数的默认值

action:参数出发的动作

store:保存参数,默认

store_const:保存一个被定义为参数规格一部分的值(常量),而不是一个来自参数解析而来的值。

store_ture/store_false:保存相应的布尔值

append:将值保存在一个列表中。

append_const:将一个定义在参数规格中的值(常量)保存在一个列表中。

count:参数出现的次数

parser.add_argument("-v", "--verbosity", action="count", default=0, help="increase output verbosity")

version:打印程序版本信息

type:把从命令行输入的结果转成设置的类型

choice:允许的参数值

parser.add_argument("-v", "--verbosity", type=int, choices=[0, 1, 2], help="increase output verbosity")

help:参数命令的介绍

 

可选参数

到目前为止,我们已经使用了位置参数。让我们来看下如何使用可选参数。

[python] view plain copy

  1. import argparse  
  2. parser = argparse.ArgumentParser()  
  3. parser.add_argument("--verbosity", help="increase output verbosity")  
  4. args = parser.parse_args()  
  5. if args.verbosity:  
  6.     print "verbosity turned on"  


接下来是输出:

[plain] view plain copy

  1. $ python prog.py --verbosity 1  
  2. verbosity turned on  
  3. $ python prog.py  
  4. $ python prog.py --help  
  5. usage: prog.py [-h] [--verbosity VERBOSITY]  
  6.   
  7. optional arguments:  
  8.   -h, --help            show this help message and exit  
  9.   --verbosity VERBOSITY  
  10.                         increase output verbosity  
  11. $ python prog.py --verbosity  
  12. usage: prog.py [-h] [--verbosity VERBOSITY]  
  13. prog.py: error: argument --verbosity: expected one argument  

 

结果分析:

 

  • 当--verbosity被指定时程序会输出回显,当没被指定时没有显示。
  • 显示的那个参数是可选的,即使没有它程序也会正常运行。注意,在默认情况下如果参数没有被使用,那么相关的变量例如本例中的args.verbosity将被指定一个None值。
  • 帮助信息有一点不同。
  • 当使用--verbosity参数的时候它必须被指定一个值,任何一个。

上面的例子中--verbosity能够接受任意整数的值,但是对于我们简单的程序来说只有两个可用的值,True or Flash。让我们修改相应的代码:

 

 

[python] view plain copy

  1. import argparse  
  2. parser = argparse.ArgumentParser()  
  3. parser.add_argument("--verbose", help="increase output verbosity",  
  4.                     action="store_true")  
  5. args = parser.parse_args()  
  6. if args.verbose:  
  7.    print "verbosity turned on"  


结果分析:

  • 现在选项并不是需要一个值,我甚至改变了它的名字用来匹配这个说法。注意,我们指定了一个新的关键词action,并且给他赋值为"store_true"。它的意思是,如果选项被指定了则将True赋值给args.verbose,没有指定则赋值Flash。
  • 当你指定一个值的时候它才被解释为True值。
  • 注意帮助信息的不同。

 

短选项

 

如果你熟悉命令行用法,你会注意到我还没有触及短选项的主题。这很简单:

[python] view plain copy

  1. import argparse  
  2. parser = argparse.ArgumentParser()  
  3. parser.add_argument("-v", "--verbose", help="increase output verbosity",  
  4.                     action="store_true")  
  5. args = parser.parse_args()  
  6. if args.verbose:  
  7.     print "verbosity turned on"  


接下来是输出:

[plain] view plain copy

  1. $ python prog.py -v  
  2. verbosity turned on  
  3. $ python prog.py --help  
  4. usage: prog.py [-h] [-v]  
  5.   
  6. optional arguments:  
  7.   -h, --help     show this help message and exit  
  8.   -v, --verbose  increase output verbosity  

请注意,新的功能也会显示在帮助信息上。

 

结合位置参数与可选参数

我们的程序不断增加复杂性:

[python] view plain copy

  1. import argparse  
  2. parser = argparse.ArgumentParser()  
  3. parser.add_argument("square", type=int,  
  4.                     help="display a square of a given number")  
  5. parser.add_argument("-v", "--verbose", action="store_true",  
  6.                     help="increase output verbosity")  
  7. args = parser.parse_args()  
  8. answer = args.square**2  
  9. if args.verbose:  
  10.     print "the square of {} equals {}".format(args.square, answer)  
  11. else:  
  12.     print answer  


接下来是输出:

[plain] view plain copy

  1. $ python prog.py  
  2. usage: prog.py [-h] [-v] square  
  3. prog.py: error: the following arguments are required: square  
  4. $ python prog.py 4  
  5. 16  
  6. $ python prog.py 4 --verbose  
  7. the square of 4 equals 16  
  8. $ python prog.py --verbose 4  
  9. the square of 4 equals 16  
  • 我们输入了位置参数,所以程序会有反应
  • 次序无关紧要

 

我们如何给程序多个值并去利用他们呢:

 

[python] view plain copy

  1. import argparse  
  2. parser = argparse.ArgumentParser()  
  3. parser.add_argument("square", type=int,  
  4.                     help="display a square of a given number")  
  5. parser.add_argument("-v", "--verbosity", type=int,  
  6.                     help="increase output verbosity")  
  7. args = parser.parse_args()  
  8. answer = args.square**2  
  9. if args.verbosity == 2:  
  10.     print "the square of {} equals {}".format(args.square, answer)  
  11. elif args.verbosity == 1:  
  12.     print "{}^2 == {}".format(args.square, answer)  
  13. else:  
  14.     print answer  


接下来是输出:

[plain] view plain copy

  1. $ python prog.py 4  
  2. 16  
  3. $ python prog.py 4 -v  
  4. usage: prog.py [-h] [-v VERBOSITY] square  
  5. prog.py: error: argument -v/--verbosity: expected one argument  
  6. $ python prog.py 4 -v 1  
  7. 4^2 == 16  
  8. $ python prog.py 4 -v 2  
  9. the square of 4 equals 16  
  10. $ python prog.py 4 -v 3  
  11. 16  


除了最后一行,上面的测试都非常完美,它暴露了我们程序的一个小bug。现在我们通过限定--verbosity的值来修改它:

[python] view plain copy

  1. import argparse  
  2. parser = argparse.ArgumentParser()  
  3. parser.add_argument("square", type=int,  
  4.                     help="display a square of a given number")  
  5. parser.add_argument("-v", "--verbosity", type=int, choices=[0, 1, 2],  
  6.                     help="increase output verbosity")  
  7. args = parser.parse_args()  
  8. answer = args.square**2  
  9. if args.verbosity == 2:  
  10.     print "the square of {} equals {}".format(args.square, answer)  
  11. elif args.verbosity == 1:  
  12.     print "{}^2 == {}".format(args.square, answer)  
  13. else:  
  14.     print answer  


接下来是输出:

 

[python] view plain copy

  1. $ python prog.py 4 -v 3  
  2. usage: prog.py [-h] [-v {0,1,2}] square  
  3. prog.py: error: argument -v/--verbosity: invalid choice: 3 (choose from 0, 1, 2)  
  4. $ python prog.py 4 -h  
  5. usage: prog.py [-h] [-v {0,1,2}] square  
  6.   
  7. positional arguments:  
  8.   square                display a square of a given number  
  9.   
  10. optional arguments:  
  11.   -h, --help            show this help message and exit  
  12.   -v {0,1,2}, --verbosity {0,1,2}  
  13.                         increase output verbosity  


注意,这些变化也体现在错误信息和帮助信息上。

让我们来使用一种不同的方法来处理verbosity参数,这是很常见的方法。这也是CPython 用来处理自己冗长的的参数的办法(查看输出python --help):

[python] view plain copy

  1. import argparse  
  2. parser = argparse.ArgumentParser()  
  3. parser.add_argument("square", type=int,  
  4.                     help="display the square of a given number")  
  5. parser.add_argument("-v", "--verbosity", action="count",  
  6.                     help="increase output verbosity")  
  7. args = parser.parse_args()  
  8. answer = args.square**2  
  9. if args.verbosity == 2:  
  10.     print "the square of {} equals {}".format(args.square, answer)  
  11. elif args.verbosity == 1:  
  12.     print "{}^2 == {}".format(args.square, answer)  
  13. else:  
  14.     print answer  


我们来介绍另一个action的参数,”count“,它用来计算一个特定的可选参数出现的次数:

[plain] view plain copy

  1. $ python prog.py 4  
  2. 16  
  3. $ python prog.py 4 -v  
  4. 4^2 == 16  
  5. $ python prog.py 4 -vv  
  6. the square of 4 equals 16  
  7. $ python prog.py 4 --verbosity --verbosity  
  8. the square of 4 equals 16  
  9. $ python prog.py 4 -v 1  
  10. usage: prog.py [-h] [-v] square  
  11. prog.py: error: unrecognized arguments: 1  
  12. $ python prog.py 4 -h  
  13. usage: prog.py [-h] [-v] square  
  14.   
  15. positional arguments:  
  16.   square           display a square of a given number  
  17.   
  18. optional arguments:  
  19.   -h, --help       show this help message and exit  
  20.   -v, --verbosity  increase output verbosity  
  21. $ python prog.py 4 -vvv  
  22. 16  
  • 是的,在我们前面的脚本中出了一个标志参数(就像action="store_true"),并且给出了相应的解释。
  • 他们的行为都和action="store_true"相似。
  • 刚刚我们演示了一下”计数“功能,在这之前你可能看到过这种做法。
  • 并且,就像action="store_true"功能一样,如果你没有指定”-v“一个参数值,那它被视为一个None值。
  • 可以预料,如果指定长形式的参数,我们可以得到同样的输出。
  • 遗憾的是,我们的帮助信息并不能识别脚本新的功能,但是我们可以进一步优化我们的脚本(例如:修改帮助参数的关键字)。
  • 最后一行输出暴露了我们程序的一个bug。

现在修复它:

[python] view plain copy

  1. import argparse  
  2. parser = argparse.ArgumentParser()  
  3. parser.add_argument("square", type=int,  
  4.                     help="display a square of a given number")  
  5. parser.add_argument("-v", "--verbosity", action="count",  
  6.                     help="increase output verbosity")  
  7. args = parser.parse_args()  
  8. answer = args.square**2  
  9.   
  10. # bugfix: replace == with >=  
  11. if args.verbosity >= 2:  
  12.     print "the square of {} equals {}".format(args.square, answer)  
  13. elif args.verbosity >= 1:  
  14.     print "{}^2 == {}".format(args.square, answer)  
  15. else:  
  16.     print answer  


接下来是输出:

[plain] view plain copy

  1. $ python prog.py 4 -vvv  
  2. the square of 4 equals 16  
  3. $ python prog.py 4 -vvvv  
  4. the square of 4 equals 16  
  5. $ python prog.py 4  
  6. Traceback (most recent call last):  
  7.   File "prog.py", line 11, in <module>  
  8.     if args.verbosity >= 2:  
  9. TypeError: unorderable types: NoneType() >= int()  


#译者注:在Python2.X中并不会出现这个错误,但在Python3.X下会报错,Python3相对于Python2修改了很多地方。

 

  • 第一行的输出还是很好的,修复了之前的bug,使我们可以输入任意>=2的数。
  • 第三行输出出了问题。

让我们修复bug:

 

[python] view plain copy

  1. import argparse  
  2. parser = argparse.ArgumentParser()  
  3. parser.add_argument("square", type=int,  
  4.                     help="display a square of a given number")  
  5. parser.add_argument("-v", "--verbosity", action="count", default=0,  
  6.                     help="increase output verbosity")  
  7. args = parser.parse_args()  
  8. answer = args.square**2  
  9. if args.verbosity >= 2:  
  10.     print "the square of {} equals {}".format(args.square, answer)  
  11. elif args.verbosity >= 1:  
  12.     print "{}^2 == {}".format(args.square, answer)  
  13. else:  
  14.     print answer  


我们刚刚介绍了另一个关键字,default。我们将它设置为0使它可以与任何int类型的值比较。记住,如果一个可选参数没有被指定,那它将是默认值None,这样他就不能与int类型值比较。(因此上文才会出现 TypeError)

接下来的输出:

[plain] view plain copy

  1. $ python prog.py 4  
  2. 16  


到目前为止,虽然我们涉及的东西还很浅,但根据我们所学的知识你可以做很多你想做的东西了。

 

更高级的用法

我们可以强化我们的程序不止用来计算平方:

[python] view plain copy

  1. import argparse  
  2. parser = argparse.ArgumentParser()  
  3. parser.add_argument("x", type=int, help="the base")  
  4. parser.add_argument("y", type=int, help="the exponent")  
  5. parser.add_argument("-v", "--verbosity", action="count", default=0)  
  6. args = parser.parse_args()  
  7. answer = args.x**args.y  
  8. if args.verbosity >= 2:  
  9.     print "{} to the power {} equals {}".format(args.x, args.y, answer)  
  10. elif args.verbosity >= 1:  
  11.     print "{}^{} == {}".format(args.x, args.y, answer)  
  12. else:  
  13.     print answer  


接下来是输出:

 

[python] view plain copy

  1. $ python prog.py  
  2. usage: prog.py [-h] [-v] x y  
  3. prog.py: error: the following arguments are required: x, y  
  4. $ python prog.py -h  
  5. usage: prog.py [-h] [-v] x y  
  6.   
  7. positional arguments:  
  8.   x                the base  
  9.   y                the exponent  
  10.   
  11. optional arguments:  
  12.   -h, --help       show this help message and exit  
  13.   -v, --verbosity  
  14. $ python prog.py 4 2 -v  
  15. 4^2 == 16  

可以看出到目前为止,我们使用--verbosity来控制文本输出,接下来的例子我们将使用它显示更多的文本:

[python] view plain copy

  1. import argparse  
  2. parser = argparse.ArgumentParser()  
  3. parser.add_argument("x", type=int, help="the base")  
  4. parser.add_argument("y", type=int, help="the exponent")  
  5. parser.add_argument("-v", "--verbosity", action="count", default=0)  
  6. args = parser.parse_args()  
  7. answer = args.x**args.y  
  8. if args.verbosity >= 2:  
  9.     print "Running '{}'".format(__file__)  
  10. if args.verbosity >= 1:  
  11.     print "{}^{} ==".format(args.x, args.y),  
  12. print answer  


接下来是输出:

[plain] view plain copy

  1. $ python prog.py 4 2  
  2. 16  
  3. $ python prog.py 4 2 -v  
  4. 4^2 == 16  
  5. $ python prog.py 4 2 -vv  
  6. Running 'prog.py'  
  7. 4^2 == 16  

 

冲突选项

 

到目前为止我们已经了解了argparse.ArgumentParser的两种实例方法,现在我们来介绍第三种,argparse.ArgumentParser()。它允许我们定义冲突的选项。现在我们修改一下程序,使它的功能更具有实用性:我们将介绍--quite选项,它与--verbosity相反:

[python] view plain copy

  1. import argparse  
  2.   
  3. parser = argparse.ArgumentParser()  
  4. group = parser.add_mutually_exclusive_group()  
  5. group.add_argument("-v", "--verbose", action="store_true")  
  6. group.add_argument("-q", "--quiet", action="store_true")  
  7. parser.add_argument("x", type=int, help="the base")  
  8. parser.add_argument("y", type=int, help="the exponent")  
  9. args = parser.parse_args()  
  10. answer = args.x**args.y  
  11.   
  12. if args.quiet:  
  13.     print answer  
  14. elif args.verbose:  
  15.     print "{} to the power {} equals {}".format(args.x, args.y, answer)  
  16. else:  
  17.     print "{}^{} == {}".format(args.x, args.y, answer)  

 

现在我们的程序很简单,因为我们去掉一些演示的功能,它的输出如下:

 

[sql] view plain copy

  1. $ python prog.py 4 2  
  2. 4^2 == 16  
  3. $ python prog.py 4 2 -q  
  4. 16  
  5. $ python prog.py 4 2 -v  
  6. 4 to the power 2 equals 16  
  7. $ python prog.py 4 2 -vq  
  8. usage: prog.py [-h] [-v | -q] x y  
  9. prog.py: error: argument -q/--quiet: not allowed with argument -v/--verbose  
  10. $ python prog.py 4 2 -v --quiet  
  11. usage: prog.py [-h] [-v | -q] x y  
  12. prog.py: error: argument -q/--quiet: not allowed with argument -v/--verbose  

 

这很容易理解,我所增加的最后一个输出向你展示了这种操作的灵活性--------长短参数掺杂使用。

 

在我们结束之前,你可能想让你的用户知道程序主要的作用,万一他们不知道:

 

 

[python] view plain copy

  1. import argparse  
  2.   
  3. parser = argparse.ArgumentParser(description="calculate X to the power of Y")  
  4. group = parser.add_mutually_exclusive_group()  
  5. group.add_argument("-v", "--verbose", action="store_true")  
  6. group.add_argument("-q", "--quiet", action="store_true")  
  7. parser.add_argument("x", type=int, help="the base")  
  8. parser.add_argument("y", type=int, help="the exponent")  
  9. args = parser.parse_args()  
  10. answer = args.x**args.y  
  11.   
  12. if args.quiet:  
  13.     print answer  
  14. elif args.verbose:  
  15.     print "{} to the power {} equals {}".format(args.x, args.y, answer)  
  16. else:  
  17.     print "{}^{} == {}".format(args.x, args.y, answer)  


注意usage信息的不同,以及[-v | -q],我们只能使用-v或者-q,但不能同时使用:

 

[plain] view plain copy

  1. $ python prog.py --help  
  2. usage: prog.py [-h] [-v | -q] x y  
  3.   
  4. calculate X to the power of Y  
  5.   
  6. positional arguments:  
  7.   x              the base  
  8.   y              the exponent  
  9.   
  10. optional arguments:  
  11.   -h, --help     show this help message and exit  
  12.   -v, --verbose  
  13.   -q, --quiet  

 

结论

 


比起我们展示的内容,argparse模块提供了更多的信息。它的文档非常详细和深入,并且包含很多例子。学习了本教程你应该很容易消化这些知识,而不至于感到不知所措。

译者注:水平有限,如有不当,还请指正。

  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Python argparse 模块是 Python 标准库中用于解析命令行参数和选项的模块。它提供了一种简单而灵活的方法来处理命令行参数,并且可以自动生成格式漂亮的帮助文档。 argparse 中有许多参数选项,其中一个是 type。type 参数指定了命令行参数的数据类型。当我们使用 argparse 解析命令行参数时,它会将字符串类型的参数转换为指定的类型。例如,如果我们指定 type=int,那么 argparse 将会把输入的字符串转换为整数类型。 argparse 提供了一些内置的类型函数,如 int、float、str、bool 等,也可以自定义类型函数。下面是一个示例,说明如何使用 type 参数来指定参数的数据类型: ```python import argparse parser = argparse.ArgumentParser() parser.add_argument('--name', type=str, help='name of the user') parser.add_argument('--age', type=int, help='age of the user') args = parser.parse_args() print(args.name) print(args.age) ``` 在上面的示例中,我们使用 add_argument() 方法添加了两个参数:--name 和 --age。type 参数分别指定了它们的数据类型为 str 和 int。 当我们在命令行中输入参数时,argparse 会自动将字符串类型的参数转换为指定的类型。例如,我们执行以下命令: ```bash python test.py --name Tom --age 25 ``` argparse 将会把 name 参数解析为字符串类型的 'Tom',将 age 参数解析为整数类型的 25。 总之,argparse 的 type 参数让我们可以轻松地控制命令行参数的数据类型,使得命令行参数处理变得更加简单和方便。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值