argparse模块使用

argparse是Python内置的一个用于命令项选项与参数解析的模块，通过在程序中定义好我们需要的参数，然后 argparse将会从sys.argv中解析出那些参数。argparse 模块还会自动生成帮助和使用手册，并在用户给程序传入无效参数时报出错误信息。

目录

argparse的使用

创建 ArgumentParser() 对象

ArgumentParser 对象

description

调用 add_argument() 方法添加参数

add_argument() 方法

使用 parse_args() 解析添加的参数

测试

---

argparse的使用

主要有三个步骤：

• 创建 ArgumentParser() 对象

• 调用 add_argument() 方法添加参数

• 使用 parse_args() 解析添加的参数

# 导入解析命令行参数模块
import argparse

# 创建一个解析对象
# description 参数用于插入描述脚本用途的信息
parser = argparse.ArgumentParser(description='YOLOv5-argparseTest')
# 向解析对象中添加所需关注的命令行参数和选项
parser.add_argument('--epochs', type=int, default=300)
parser.add_argument('--batch-size', type=int, default=16, help='total batch size for all GPUs, -1 for autobatch')
parser.add_argument('--evolve', type=int, nargs='?', const=300, help='evolve hyperparameters for x generations')
# 解析添加的参数
args = parser.parse_args()
# 打印帮助文档
parser.print_help()
# 输出参数
print('epochs:', args.epochs)
print('batch-size:', args.batch_size)
print('evolve:', args.evolve)

创建 ArgumentParser() 对象

使用 argparse 的第一步是创建一个 ArgumentParser 对象：

parser = argparse.ArgumentParser(description='YOLOv5-argparseTest')

ArgumentParser 对象包含将命令行解析成 Python 数据类型所需的全部信息。

ArgumentParser 对象

创建一个新的 ArgumentParser 对象。所有的参数都应当作为关键字参数传入。

class argparse.ArgumentParser(prog=None, usage=None, description=None, epilog=None, parents=[], formatter_class=argparse.HelpFormatter, prefix_chars='-', fromfile_prefix_chars=None, argument_default=None, conflict_handler='error', add_help=True, allow_abbrev=True, exit_on_error=True)

• prog - The name of the program (default: os.path.basename(sys.argv[0]))

• usage - 描述程序用途的字符串（默认值：从添加到解析器的参数生成）

• description - 在参数帮助文档之前显示的文本（默认值：无）

• epilog - 在参数帮助文档之后显示的文本（默认值：无）

• parents - 一个 ArgumentParser 对象的列表，它们的参数也应包含在内

• formatter_class - 用于自定义帮助文档输出格式的类

• prefix_chars - 可选参数的前缀字符集合（默认值： '-'）

• fromfile_prefix_chars - 当需要从文件中读取其他参数时，用于标识文件名的前缀字符集合（默认值： None）

• argument_default - 参数的全局默认值（默认值： None）

• conflict_handler - 解决冲突选项的策略（通常是不必要的）

• add_help - 为解析器添加一个 -h/--help 选项（默认值： True）

• allow_abbrev - 如果缩写是无歧义的，则允许缩写长选项 （默认值：True）

• exit_on_error - 决定当错误发生时是否让 ArgumentParser 附带错误信息退出。 (默认值: True)

description

大多数对 ArgumentParser 构造方法的调用都会使用 description= 关键字参数。 这个参数简要描述这个程序做什么以及怎么做。 在帮助消息中，这个描述会显示在命令行用法字符串和各种参数的帮助消息之间:

usage: argparseTest.py [-h] [--epochs EPOCHS] [--batch-size BATCH_SIZE]
                       [--evolve [EVOLVE]]
​
YOLOv5-argparseTest
​
optional arguments:
  -h, --help            show this help message and exit
  --epochs EPOCHS
  --batch-size BATCH_SIZE
                        total batch size for all GPUs, -1 for autobatch
  --evolve [EVOLVE]     evolve hyperparameters for x generations

调用 add_argument() 方法添加参数

给一个 ArgumentParser 添加程序参数信息是通过调用 add_argument() 方法完成的。通常，这些调用指定 ArgumentParser 如何获取命令行字符串并将其转换为对象。这些信息在 parse_args() 调用时被存储和使用。例如：

parser.add_argument('--epochs', type=int, default=300)
parser.add_argument('--batch-size', type=int, default=16, help='total batch size for all GPUs, -1 for autobatch')
parser.add_argument('--evolve', type=int, nargs='?', const=300, help='evolve hyperparameters for x generations')

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 - 解析后的参数名称，默认情况下，对于可选参数选取最长的名称，中划线转换为下划线.

使用 parse_args() 解析添加的参数

ArgumentParser 通过 parse_args() 方法解析参数。它将检查命令行，把每个参数转换为适当的类型然后调用相应的操作。在大多数情况下，这意味着一个简单的 Namespace 对象将从命令行解析出的属性构建：

args = parser.parse_args()

在脚本中，通常 parse_args() 会被不带参数调用，而 ArgumentParser 将自动从 sys.argv 中确定命令行参数。

测试

python Test/argparseTest.py

epochs: 300
batch-size: 16
evolve: None

python Test/argparseTest.py --epochs 200 --batch-size 8 --evolve 1

epochs: 200
batch-size: 8
evolve: 1