首页 » Python » python argparse 使用

python argparse 使用

 

一、简介:

argparse是python用于解析命令行参数和选项的标准模块,用于代替已经过时的optparse模块。argparse模块的作用是用于解析命令行参数,例如python parseTest.py input.txt output.txt --user=name --port=8080。

二、使用步骤:

1:import argparse

2:parser = argparse.ArgumentParser()

3:parser.add_argument()

4:parser.parse_args()

 

 

首先,从最简单的一个例子开始吧

运行一下

结果分析:

  • 不加任何参数运行,什么也不显示,没有什么用。
  • 第二条展示了argparse模块的好处,几乎什么都不做,却得到了一个很有用的帮助信息。
  • --help参数可简写成-h,是唯一预设的(不需要指定)。

定位参数

例子:

运行:

结果分析:

  • 我们用到了方法add_argument(),用来指定程序需要接受的命令参数,本例中的echo
  • 现在运行程序必须指定一个参数。
  • 方法parse_args()通过分析指定的参数返回一些数据,如本例中的echo
  • 像魔法一样,argparse自动生成这些变量,你可能已经注意到变量echo和我们指定的参数相同。

虽然现在帮助信息已经很美观了,但是还不够好。例如我们知道echo是个定位参数,但是却不知道该参数的意思,只能通过猜或者读源码。下面,我们可以让它更有帮助:

运行:

再修改下:

运行如下:

运行有点问题,因为如果不指定参数类型,argparse默认它是字符串。因此我们需要告诉argparse该参数是整型。

运行:

可以运行了,程序能够在执行前过滤一些错误的参数输入。

可选参数

以上,展示了定位参数的用法。下面让我们来看看如何添加可选参数:

输出:

结果分析:

  • 当指定--verbosity时程序就显示一些东西,没指定的时候就不显示。
  • 这个参数事实上是可选的,不指定它也不会出错。如果不指定可选的参数,对应的变量就被设置为None,比如本例中的args.verbosity, 这就是为什么示例中的 if 没有执行的原因。
  • 帮助信息发生了点变化
  • 当我们使用可选参数--verbosity时,也必须指定一些值。

上面的示例中可选参数--verbosity后面接受任意的整型值,但是对于简单的程序,实际上只需要两种值,True或者False。因此可以修改上面的代码:

运行:

结果分析:

  • 现在多加一个标志来替代必须给出一些值,并修改了名称来表达我们的意思。注意现在指定了一个新的关键词action,并且赋值为store_ture。如果指定了这个可选参数,args.verbose就赋值为True,否则就为False
  • 多指定了值,它就会发出错误提示。
  • 注意帮助文档有什么不同

简写

如果你很熟悉命令行,你可能已经注意到我在上面已经提到了参数的简写,非常的简单:

运行如下:

注意帮助信息也有相应的变化。

混合使用定位参数和可选参数

再复杂一点:

运行:

  • 为了让程序复杂点,我们重新加上了定位参数。
  • 注意到参数的顺序是没有影响的。

来看看为程序加上处理重复参数的能力会怎么样:

运行:

除了最后一个暴露了一个bug,其他的看起都来运行良好。让我们通过限制--verbosity后面跟的值来修正:

运行:

注意帮助信息和错误信息都发生了变化。

现在让我们用一种更常用的方法来处理,类似CPython处理自己的参数(参考python --help):

我们引入了另一个关键词count来统计可选参数出现的次数:

  • 和前面的版本相比这里多了一个关键词(类似action="store_true")。
  • 行为上也类似store_true
  • count关键词的示范,大家可能在其他地方已经看过了。
  • 就像store_ture,如果不指定-v,响应变量就会被设置为None
  • 指定完整的名称和简写效果是一样的。
  • 但是不爽的是,帮助信息并没有做出有用的提示,不过可以通过修改help来改善这个问题。
  • 最后那个输出又暴露了程序的bug

修改一下:

运行如下:

  • 第一个输出是正确的,修正了上个版本的问题,参数出现次数>=2时都能显示详细的信息。
  • 第三个输出还是有问题

再来修改下:

我们又加入了一个关键词default。设置它的默认值为0,这样可以让它兼容其他整型。注意,如果一个可选参数没有指定,它就会被设置成NoneNone是不能和整型比较的(触发[TypeError][5]异常)。

运行结果:

你可以使用我们所学来做很多事情,但是这仅仅是皮毛而已。argparse模块非常强大,下面来看看更多的用法。

高级用法

如果我们想扩展程序的功能,而不仅仅是求平方:

输出:

截止到目前,我们都在利用详细的级别来改变输出,下面的示例演示了利用详细的级别来显示更多输出:

输出:

参数冲突

迄今为止,我们已经使用到了[argparse.ArgumentParser][6]的两个方法,来看看他的另一个方法add_mutually_exclusive_group()。它可以让我们指定某个参数和其他参数冲突。下面来修改下程序以对这个新方法有更多的了解:我们将加入参数--quiet,它和参数--verbose冲突,不能同时指定:

程序很简单,为了演示冲突,去掉了其他功能特性展示,运行结果:

很好理解,我们添加最后那个输出是为了展示灵活性,比如,指定参数时可以同时混用参数全称和简写。

通过前面的学习,为了以防万一,你可能想通过帮助信息来告诉用户如何使用你的程序:

注意下面的帮助信息,[-v | -q]表明了可以使用-v或者-q,但是不能同时使用。

总结

argparse模块提供了比我们展示的多得多的功能。它的文档更加详尽和深入,并且配了大量的示例。自己去深入阅读下,文档很容易理解。

 

原文链接:python argparse 使用,转载请注明来源!

0