Python内置模块：argparse使用详解

目录

一、简介

二、常用方法可选参数详解

ArgumentParser 对象

add_argument() 方法  

parse_args()方法

选项值语法

---

一、简介

argparse 是 python 内置的标准模块，可以让人轻松编写对用户友好的命令行接口，能够直接在命令行中向程序传入参数并使程序运行。

下面先从一个简单的例子出发对 argparse 的使用进行介绍：

#demo.py
import argparse

#创建 parser 对象
parser = argparse.ArgumentParser()
#向 parser 中添加参数
parser.add_argument('name', type=str)
parser.add_argument('gender', type=str)
parser.add_argument('age', type=int)

#解析命令行参数并返回一个包含参数值的 Namespace 对象
args = parser.parse_args()

print(args)

首先创建一个 ArgumentParser 对象，称为解析器，其包含将命令行解析成 Python 数据类型所需的全部信息。接着使用 add_argument 方法添加参数信息，最后使用 parse_args 方法解析命令行参数并返回一个包含参数值的 Namespace 对象。总的来说，实现流程分为三步：创建解析器，添加参数，解析参数。

在终端中输入

python demo.py david male 17

得到结果

Namespace(age=17, gender='male', name='david')

结果是一个 argparse.Namespace 对象，其中包含了命令行参数的信息。每个命令行参数都被存储为 args 对象的属性，可以通过点号操作符来访问它们的值，比如 args.name 等。

二、常用方法可选参数详解

在理解以上必选参数的使用后，接下来会介绍该对象各个方法常用可选参数的使用。

• 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)

prog - 程序的名称（默认值：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）

以上参数通常情况下只需要关注 description ，这个参数简要描述这个程序做什么以及怎么做。 在帮助消息中，这个描述会显示在命令行用法字符串和各种参数的帮助消息之间，用户可以使用python filename.py -h 或者 python filename.py --help 来获取对该程序的描述：

#description
parser = argparse.ArgumentParser(description='student information')

#Terminal
$python demo.py -h
student information

• 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 - 当参数在命令行中出现时使用的动作基本类型。
nargs - 命令行参数应当消耗的数目。
const - 被一些 action 和 nargs 选择所需求的常数。
default - 当参数未在命令行中出现时使用的值。
type - 命令行参数应当被转换成的类型。
choices - 可用的参数的容器。
required - 此命令行选项是否可省略 （仅选项可用）。
help - 一个此选项作用的简单描述。
metavar - 在使用方法消息中使用的参数值示例。
dest - 被添加到 parse_args() 所返回对象上的属性名。

这些形参常用的是 name or flags，nargs，default，type，required，help 。

name or flags 是用于指定命令行参数的名称或选项列表。name 表示参数名，其赋值与位置顺序相关，因此也叫位置参数名，命令行中必须赋值；flags 表示 - 或者 -- 开头的参数名，命令行中可选参数。通过使用不同的名称或选项，可以为参数提供不同的方式进行调用。

import argparse

parser = argparse.ArgumentParser()
#可选的flags参数
parser.add_argument('-f', '--foo')
parser.add_argument('--flag')
#必选的name位置参数
parser.add_argument('bar')

opt1 = parser.parse_args(args=['-f=1', '3'])
opt2 = parser.parse_args(args=['--foo=1', '--flag=2', '3'])
'''
或者 (parse_args()方法在后文提到)
opt1 = parser.parse_args(args=['-f', '1', '3'])
opt2 = parser.parse_args(args=['--foo', '1', '--flag', '2', '3'])
'''
print(opt1, '\n', opt2, sep='')

#输出结果
Namespace(bar='3', flag=None, foo='1')
Namespace(bar='3', flag='2', foo='1')

以 -- 开头的参数为可选参数，相应的以 - 开头的参数可以视为可选参数的别名，通常是可选参数的首字母，所以也称为单字母选项或短选项。在实际使用时，考虑到复杂使用情况，较少使用位置参数。可选参数虽然写法比较繁琐，但是增加了命令行中的可读性，不容易因为参数传入顺序导致数据错乱。总而言之，推荐使用可选参数，在使用位置参数或者短选项时需要慎重考虑。 

import argparse

parser = argparse.ArgumentParser(description='student infomation')

parser.add_argument('--name', '-n', type=str, help='student full name', required=True)
#require：必需的选项通常被认为是不适宜的，因为用户会预期 options 都是可选的，因此在可能的情况下应当避免使用它们。
parser.add_argument('--gender', '-g', type=str, help='male or female')
parser.add_argument('--age',type=int,default=18)
parser.add_argument('--remark',nargs='*')

args = parser.parse_args()
print('student name:', args.age)
print(args)

参数 nargs ：
nargs='*'　表示参数可设置零个或多个
nargs='+'   表示参数可设置一个或多个
nargs='?'　表示参数可设置零个或一个

#Terminal
$python demo.py -h
usage: demo.py [-h] --name NAME [--gender GENDER] [--age AGE] [--remark [REMARK [REMARK ...]]]

student infomation

optional arguments:
  -h, --help            show this help message and exit
  --name NAME, -n NAME  student full name
  --gender GENDER, -g GENDER
                        male or female
  --age AGE
  --remark [REMARK [REMARK ...]]

$python demo.py --name=alex, --gender=male, --remark=1,2
student name: 18
Namespace(age=18, gender='male,', name='alex,', remark=['1,2'])

• parse_args()方法

选项值语法

parse_args() 方法支持多种指定选项值的方式（如果它接受选项的话）。 在最简单的情况下，如上文通过 parse_args() 传入参数的例子所示，选项和它的值是作为两个单独参数传入的。

>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('-x')
>>> parser.add_argument('--foo')
>>> parser.parse_args(['-x', 'X'])
Namespace(foo=None, x='X')
>>> parser.parse_args(['--foo', 'FOO'])
Namespace(foo='FOO', x=None)

对于长选项（名称长度超过一个字符的选项），选项和值也可以作为单个命令行参数传入，使用 = 分隔它们即可：

>>> parser.parse_args(['--foo=FOO'])
Namespace(foo='FOO', x=None)

对于短选项（长度只有一个字符的选项），选项和它的值可以拼接在一起:

>>> parser.parse_args(['-xX'])
Namespace(foo=None, x='X')

---

argparse 在一些需要频繁传入调试参数的程序中相对常用，下面以 yolov7 为例贴出 argparse 在实际应用场景上的运用，帮助理解其使用场景

<pass>
parser = argparse.ArgumentParser()
parser.add_argument('--data', type=str, default="data/skewer.yaml", help='*.data path')
parser.add_argument('--hyp', type=str, default="data/hyp.scratch.tiny.yaml")
parser.add_argument('--batch-size', type=int, default=16, help='size of each image batch')
parser.add_argument('--gs', type=int, default=32)
parser.add_argument('--img-size', type=int, default=320, help='inference size (pixels)')
parser.add_argument('--task', default='train', help='train, val, test, speed or study')
parser.add_argument('--single-cls', action='store_true', help='treat as single-class dataset')
<pass>   #在此代码块中通过 opt 点访问参数进行具体操作

#传入参数运行代码
!python train.py --epochs 50 --device 0 --batch-size 16 --data data/skewer.yaml --img 640 640 --cfg cfg/training/yolov7-tiny.yaml --weights '' --name skewer --hyp data/hyp.scratch.tiny.yaml --exist-ok

对于轻度使用者，只需要记住在添加参数时使用可选参数、类型以及默认值、帮助信息即可，这些是使用 argparse 时的核心要点，足以满足大多数简单应用场景的需求。而其他的附加特性可以在必要时再深入学习和使用。

本文仅简单介绍了常用的 argparse 使用方法，想深入了解可以点击此处访问 python 官方中文文档。