命令行参数工具是我们非常常用的工具。比如我们在实验中想要调整参数时，如果参数是硬编码写在代码中的，那么每次修改参数都需要修改相应的代码和逻辑，显然是不方便的。更好的方法是以通过命令行传入,的形式设置必要的参数，这样我们只需要在运行时修改参数。

sys.argv

解析从命令行传入的参数最简单的方法是通过sys.argv,sys.argv可以获得我们从命令行传入的参数。

导入系统

打印(sys.argv)

用法很简单，只需调用sys.argv Argv就是一个数组。如果有多个参数，我们可以通过下标来访问。但是，需要注意的是，存储在argv中的结果以Python调用开始。

我们来看一个例子。我们随机传入一些参数。打印sys.argv后，看起来是这样的。

python test.py -a -c -d=222

['test.py '，'-a '，'-c '，'-d=222']

也就是说，我们python运行test.py的文件名也当做参数之一，所以如果我们想要获得自定义参数，我们需要从argv[1]开始。

sys.argv的优点是方便。我们只需要访问它来获取传入的参数。但缺点也很明显，就是功能太少。如果我们看的是其他神的代码，我们想知道运行时需要传入哪些参数，每个参数代表什么意思，所以做不到。

为了解决这个问题，我们需要使用封装更多功能的工具，这也是本文的核心：——argparse.

基本用法

Argparse是Python中的一个库。我们需要先导入它。我没记错的话，这个库应该是Python自带的，不需要安装。我们可以直接使用。

在使用它之前，我们需要初始化这个解析器，它是一个参数解析器。

#这里ArgumentParser可以传入一个字符串来指示目的。

parser=argparse。ArgumentParser()

parser.parse_args()

此时，我们已经有了一个解析器，我们可以在运行时传入参数-h来表示帮助，也就是查看当前解析器中定义的参数。既然我们现在一无所有，能展示的只有帮助。

必选参数

首先我们来介绍一下必选参数.它的定义和函数中需要的参数是一样的，也就是说我们运行程序需要的参数。如果没有，则不应执行该程序，并将报告并提示错误。

定义所需参数的方法非常简单。我们只需要通过add_argument传入参数的名称。

导入参数解析

parser=argparse。参数解析器(“用于测试解析器”)

parser.add_argument('test ')

args=parser.parse_args()

打印(args.test)

这样，我们定义了一个名为test的参数，我们可以通过args.test来访问它

此时，当我们再次运行python test.py -h时，我们会发现消息中多了一行：

告诉我们需要的参数之一是test，必选参数直接传入，不需要加上前缀.因此，当我们执行时，可以直接使用python test.py xxx。

可选参数

如果有必要的参数，当然有可选的参数。因为可选参数是可选的，所以在使用参数时，我们需要在参数之前添加一个标识符。例如，我们的名为test的参数可以定义为-test或-test，两者都可以定义。

parser.add_argument('-test '，'-test ')

我

但是这个只print出来了参数名，并没有告诉我们这个参数究竟是做什么的，像是help参数后面就跟了show this help message and exit这个提示语。如果我们也希望help能够提示我们参数的作用怎么办呢？

我们可以通过help参数传入我们希望打印出来的提示语，这样方便使用者在使用的时候了解参数的情况。

比如我们把这行语句改成：

parser.add_argument('-test', '--test', help='just for help')

这样当我们运行的时候，就会看到提示语了：

默认值

如果参数很多的时候，我们有时候可能不希望每一个都指定一个值，而是希望可以在不填的时候有一个默认值。这个想法非常正常，想要做到这点也很简单，我们可以通过default参数来指定。

import argparse
parser = argparse.ArgumentParser("For test the parser")
parser.add_argument('-test', '--test', default=1, help='just for help')
args = parser.parse_args()
print(args.test)

比如这样我们在代码当中把test参数的默认值设置成了1，当我们运行的时候，如果不填test这个参数的话，那么程序就会使用它的默认值也就是1。

但有一点默认值的信息并不会print在help当中，所以我们需要自己在提示语当中告知使用者默认值是多少。

type

我们可以定义参数的默认值，当然也可以定义它的类型。

因为命令行传入的参数默认都是字符串，如果我们要进行数学上的计算，使用str还需要自己转换，这就很不方便。我们可以在传入参数的时候就完成类型的匹配，这样如果传入参数的类型不对， 那么直接报错，不往下运行。

想要做到这点也很简单，通过type参数就可以实现。

parser.add_argument('-test', '--test', default=1, type=int, help='just for help')

比如当我们定义了一个int型的参数，而传入的是类型不匹配的话，那么就会引起报错：

报错信息当中写得很清楚，我们得到了一个无效的int的值，它是abc。

可选值

它同样还支持可选值，可选值很好理解，就是我们希望限定传入参数的范围仅仅在几个值当中。比如说我们希望传入的值不是0就是1，或者是在某几个具体的值当中，这个时候我们可以通过choices参数来实现这一点。

choices参数传入的是一个list，也就是我们的限定范围，只有在这个范围当中的值才被允许。

parser.add_argument('-test', '--test', default=1, choices=[2, 3, 4], type=int, help='just for help')

如果我们运行传入test=1，那么就会引起报错，告诉我们传入的值不在choices范围当中。

这是一个挺有意思的例子，仔细看会发现我们默认值设置成了1，但是可选值当中并没有1。这也是允许的，默认值可以不在可选值范围内，但是当我们传入1就会触发可选值校验。

action

action是一个很神奇也很有用的操作，可以指定参数的处理方式。我们默认的方式是store，也就是存储的意思，这个我们都能理解。除此之外，还有store_true，它表示出现则是true，否则是false。

parser.add_argument('-test', '--test', action='store_true', help='just for help')

当我们把test参数的定义改成这样之后，我们来对比一下运行的结果就明白了。

除了store_true之外还有store_const，也就是说出现就指定为一个固定值。

parser.add_argument('-test', '--test', action='store_const', const=23, help='just for help')

这样当我们指定-test参数之后，它会自动被赋值成23。

除了这两个之外，另外一个很常用的参数是append，可以将多次出现的同一个参数自动存入一个list当中。

parser.add_argument('-test', '--test', action='append', type=int, help='just for help')

nargs

nargs也是一个非常有用的参数，可以对参数进行一些花式操作。nargs的传入参数有以下几种，首先是N，也就是一个整数。代表可以接收N个参数值，这N个值会被存入一个list当中。

parser.add_argument('-test', '--test', nargs=2, type=int, help='just for help')

另外一种传入的参数是’+’或者是’*’，它可以将任意多个值存入一个list当中。

parser.add_argument('-test', '--test', nargs='*', type=int, help='just for help')

总结

有了parser之后，我们在Python当中处理命令行参数会变得非常简单，我们可以做各种各样的定制化操作。除了我们上面介绍的之外，还有一些其他的做法，相对来说不是非常常用，所以就不一一穷尽了，感兴趣的同学可以自行了解一下。