Python的argparse-IGI

时间：2020-02-23 14:42:25 　来源:igfitidea点击:

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

Python的argparse

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

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

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

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

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指定为可选或者必需选项的选项。
在最后一种情况下，我们使用了一个未知选项argparse，
声称是"无法识别的论点"。

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

Python argparse位置参数

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

import argparse

parser = argparse.ArgumentParser()
parser.add_argument("blog")
args = parser.parse_args()

if args.blog == 'theitroad':
  print('You made it!')
else:
  print("Didn't make it!")

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

Python argparse位置参数默认值

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

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

import argparse

parser = argparse.ArgumentParser()
parser.add_argument('blog', nargs='?', default="theitroad")
args = parser.parse_args()

if args.blog == 'theitroad':
  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="theitroad", help="Best blog name here.")
args = parser.parse_args()

if args.blog == 'theitroad':
  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作为输入运行时，我们得到以下输出：

发生这种情况是因为Python将3视为String，因此它只是在相同的String3时间后面附加了时间。

如果我们借助type属性将数据类型告知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 == 'theitroad':
  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 == 'theitroad':
  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 == 'theitroad':
  print('You made it!')

if args.writer == 'Shubham':
  print('Technical Author.')

Python的argparse