Python—argparse模块

参考官方文档：argparse — 命令行选项、参数和子命令解析器

argparse 模块可以让人轻松编写用户友好的命令行接口。
程序定义它需要的参数，然后 argparse 将弄清如何从 sys.argv 解析出那些参数。
argparse 模块还会自动生成帮助和使用手册，并在用户给程序传入无效参数时报出错误信息。

示例

以yolov6中train.py为例：

parser = argparse.ArgumentParser(description='YOlov6 PyTorch Training', add_help=add_help)
parser.add_argument('--data-path', default='./data/coco.yaml', type=str, help='path of dataset')
parser.add_argument('--conf-file', default='./configs/yolov6s.py', type=str, help='experiments description file')
parser.add_argument('--img-size', default=640, type=int, help='train, val image size (pixels)')
parser.add_argument('--batch-size', default=32, type=int, help='total batch size for all GPUs')
parser.add_argument('--epochs', default=400, type=int, help='number of total epochs to run')
parser.add_argument('--workers', default=8, type=int, help='number of data loading workers (default: 8)')
parser.add_argument('--device', default='0', type=str, help='cuda device, i.e. 0 or 0,1,2,3 or cpu')
parser.add_argument('--eval-interval', default=20, type=int, help='evaluate at every interval epochs')
parser.add_argument('--check-images', action='store_true', help='check images when initializing datasets')
parser.add_argument('--check-labels', action='store_true', help='check label files when initializing datasets')

args = parser.parse_args()

大致流程

1、首先，创建一个ArgumentParser 对象：

parser = argparse.ArgumentParser(description='YOlov6 PyTorch Training', add_help=add_help)

2、然后使用add_argument()函数添加程序参数：

 parser.add_argument('--data-path', default='./data/coco.yaml', type=str, help='path of dataset')

3、最后，使用parse_args()函数解析参数：

args = parser.parse_args()

细节

argparse.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	程序的名称	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

ArgumentParser.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() 所返回对象上的属性名

其中，需要特别解释action参数。此处参考：action的可选参数store_true的作用
当action设置为store_true时，仍以上述示例为例

# test.py
parser.add_argument('--check-images', action='store_true', help='check images when initializing datasets')

args = parser.parse_args()
res = args.check-images
print(res)

未设置default时：
1、触发check-images，输出为True

python test.py --check-images
# 输出为 True

2、不触发check-images，输出为False

python test.py
# 输出为 False

设置default=True时：

# test.py
parser.add_argument('--check-images', default='True', action='store_true', help='check images when initializing datasets')

1、触发check-images，输出为True

python test.py --check-images
# 输出为 True

2、不触发check-images，输出为True

python test.py
# 输出为 True

设置default=False时：

# test.py
parser.add_argument('--check-images', default='False', action='store_true', help='check images when initializing datasets')

1、触发check-images，输出为True

python test.py --check-images
# 输出为 True

2、不触发check-images，输出为False

python test.py
# 输出为 False

ArgumentParser.parse_args

对命名空间进行解析，将参数字符串转换为对象并将其设为命名空间的属性。 返回带有成员的命名空间。

ArgumentParser.parse_args(args=None, namespace=None)

参数	描述	默认值
args	要解析的字符串列表	从 sys.argv 获取
namespace	用于获取属性的对象	一个新的空 Namespace 对象

例：

>>> parser = argparse.ArgumentParser(prog='PROG')
>>> 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')