Python argparse模块解析命令行参数

Python argparse模块是解析命令行参数的首选方法。解析命令行参数是一个非常常见的任务，Python脚本根据传递的值来执行和操作。

Python的argparse

Python argparse是Python中推荐的命令行参数解析模块。这对于getopt模块来说非常常见，但是有点复杂，并且通常需要更多代码来完成同一任务。

让我们研究一下使用此模块可以解析命令行参数的各种方法。

为什么我们需要Python argparse模块？

argparse通过看一个使用sys模块的简单示例，我们将尝试建立对模块的需求：

 

import sys

 

if len(sys.argv) > 1:

    print("Argument 1: {}".format(sys.argv[0]))

    print("Argument 2: {}".format(sys.argv[1]))

else:

    print("No arguments passed.")

没有传递任何参数，输出将是：

显然，即使脚本名称也被捕获为命令行参数，因为这就是它的用途python。

Python argparse示例

现在，您必须考虑到上面的示例在获取参数和使用参数方面很简单。但是事实是，当脚本需要参数而没有将参数传递给它时，问题就开始了。

使用argparse，我们可以很好地处理参数的不存在和存在。让我们研究一个简单的例子：

 

import argparse

parser = argparse.ArgumentParser()

parser.parse_args()

让我们使用不同的选项来多次运行脚本，以查看其结果：

让我们了解一下运行脚本时发生的情况：

• 首先，我们不带参数地运行程序。在这种情况下，脚本保持沉默。
• 该--help选项是唯一不需要我们将argparse指定为optional或required的选项。
• 在最后一种情况下，我们使用了一个未知选项argparse，
  声称为unrecognized arguments。

因此，使用argparse，我们可以定义期望的参数和可选的参数。

Python argparse位置参数

现在，在脚本中，通常需要我们在执行时强制将其传递给脚本的参数。如果未通过，我们将看到错误。让我们来看一个例子：

 

import argparse

 

parser = argparse.ArgumentParser()

parser.add_argument("blog")

args = parser.parse_args()

 

if args.blog == 'JournalDev':

    print('You made it!')

else:

    print("Didn't make it!")

当我们使用不同的参数运行脚本时，无，更正等：

因此，通过这种方式，我们可以在不传递参数时显示错误，并在传递参数时也管理不同的值。

Python argparse位置参数默认值

在我们的最后一个示例中，未提供位置参数值是空的。但是有时候我们想要变量或参数的默认值，我们可以使用argparse模块来实现。

查看有关如何为参数传递默认值的示例：

 

import argparse

 

parser = argparse.ArgumentParser()

parser.add_argument('blog', nargs='?', default="JournalDev")

args = parser.parse_args()

 

if args.blog == 'JournalDev':

    print('You made it!')

else:

    print("Didn't make it!")

当我们使用不同的参数运行脚本时，无，更正等：

这次，随着默认值的传递，可以很好地管理缺少参数的情况。

Python argparse参数帮助

每当我们制作一个新的Python脚本时，我们就知道要传递什么参数，以及每个参数的命运。但是，对于我们的脚本一无所知的用户呢？他怎么知道要传递哪些论据，按什么顺序执行它们呢？

这是add_argument函数中的另一个属性可以拯救的地方：

 

import argparse

 

parser = argparse.ArgumentParser()

parser.add_argument('blog', default="JournalDev", help="Best blog name here.")

args = parser.parse_args()

 

if args.blog == 'JournalDev':

    print('You made it!')

else:

    print("Didn't make it!")

现在，当我们以（-h寻求帮助）运行脚本时：

 

python argparse_positional_help.py -h

我们得到以下输出：

这样不好吗 这样，脚本的用户只需要查看他/她应通过的内容和顺序即可。优秀的！

位置参数数据类型

现在，除非您告诉Python不这样做，否则位置参数始终被视为字符串。让我们看一下示例代码片段：

 

import argparse

 

parser = argparse.ArgumentParser()

parser.add_argument('number', help="Enter number to triple it.")

args = parser.parse_args()

print(args.number*3)

在此脚本中，我们只是将数字乘以三。当将其3作为输入运行时，将获得以下输出：

这happended因为Python处理3的String，所以它只是附加相同的字符串3时。

如果我们借助typeattribute 将数据类型告知Python，则可以更正此问题：

 

import argparse

 

parser = argparse.ArgumentParser()

parser.add_argument('number', help="Enter number to cube.", type=int)

args = parser.parse_args()

print(args.number*3)

这次，当运行此脚本3作为输入时，我们得到以下输出：

这样，我们甚至可以确保传递的数据类型正确。

Python argparse可选参数

现在，在脚本中，通常需要将可选参数传递给脚本时。如果未通过，我们将不会看到错误。让我们来看一个例子：

 

import argparse

 

parser = argparse.ArgumentParser()

parser.add_argument('--blog', help="Best blog name here.")

args = parser.parse_args()

 

if args.blog == 'JournalDev':

    print('You made it!')

这次，我们使用--了可选参数名称。当我们运行脚本时：

在--可选参数名称之前使用，我们可以按任意顺序定义可选参数。

传递默认值，帮助消息和可选参数的数据类型的方法与位置参数中的方法相同。请注意，如果没有将值传递给可选参数，则会为程序分配一个值None。

argparse可选参数的简称

在上面的示例中，我们非常清楚需要可选地传递用户什么值。很好，但是如果脚本中可选参数的描述性名称长了，该怎么办。幸运的是，我们也可以为参数分配一个短名称。让我们看一个示例片段：

 

import argparse

 

parser = argparse.ArgumentParser()

parser.add_argument('-b', '--blog', help="Best blog name here.")

args = parser.parse_args()

 

if args.blog == 'JournalDev':

    print('You made it!')

那不是那么简单吗？只需在add_argument函数中使用一个额外的参数即可。让我们现在运行此脚本：

将可选参数和位置参数与argparse结合

我们还可以在脚本中结合使用可选和位置命令行参数。让我们快速看一个例子：

 

import argparse

 

parser = argparse.ArgumentParser()

parser.add_argument('blog', help="Best blog name here.")

parser.add_argument('-w', '--writer', help="Team Player.")

args = parser.parse_args()

 

if args.blog == 'JournalDev':

    print('You made it!')

 

if args.writer == 'Shubham':

    print('Technical Author.')

当我们运行脚本时：

add_argument() 方法
add_argument() 方法定义如何解析命令行参数：

ArgumentParser.add_argument(name or flags...[, action][, nargs][, const][, default][, type][, choices][, required][, help][, metavar][, dest])
每个参数解释如下:

name or flags - 选项字符串的名字或者列表，例如 foo 或者 -f, --foo。
action - 命令行遇到参数时的动作，默认值是 store。
store_const，表示赋值为const；
append，将遇到的值存储成列表，也就是如果参数重复则会保存多个值;
append_const，将参数规范中定义的一个值保存到一个列表；
count，存储遇到的次数；此外，也可以继承 argparse.Action 自定义参数解析；
nargs - 应该读取的命令行参数个数，可以是具体的数字，或者是?号，当不指定值时对于 Positional argument 使用 default，对于 Optional argument 使用 const；或者是 * 号，表示 0 或多个参数；或者是 + 号表示 1 或多个参数。
const - action 和 nargs 所需要的常量值。
default - 不指定参数时的默认值。
type - 命令行参数应该被转换成的类型。
choices - 参数可允许的值的一个容器。
required - 可选参数是否可以省略 (仅针对可选参数)。
help - 参数的帮助信息，当指定为 argparse.SUPPRESS 时表示不显示该参数的帮助信息.
metavar - 在 usage 说明中的参数名称，对于必选参数默认就是参数名称，对于可选参数默认是全大写的参数名称.
dest - 解析后的参数名称，默认情况下，对于可选参数选取最长的名称，中划线转换为下划线.

在本课程中，我们学习了可以使用Python中的Argbase模块管理命令行参数的各种方法。