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
2
3
4
5
6
7
8
9
10
11
12
13
14

大致流程

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

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

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

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

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

args = parser.parse_args()
1

细节

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)
1
2
3
4
5
6
7
8
9
10
11
12
13

ArgumentParser.add_argument

定义单个的命令行参数应当如何解析。

ArgumentParser.add_argument(name or flags...
						    [, action][, nargs][, const][, default][, type][, choices][, required][, help][, metavar][, dest])
1
2

其中，需要特别解释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)

1
2
3
4
5
6
7

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

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

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

python test.py
# 输出为 False
1
2

设置default=True时：

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

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

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

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

python test.py
# 输出为 True
1
2

设置default=False时：

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

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

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

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

python test.py
# 输出为 False
1
2

ArgumentParser.parse_args

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

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

例：

>>> 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)
1
2
3
4
5
6
7

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

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

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

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