argparse解析命令行参数

关注

原创最新推荐文章于 2026-02-16 13:17:27 发布 7.3k 阅读 AI 写同款· GEO 优化 ›

Python | 使用argparse解析命令行参数 今天是Python专题第27篇文章，我们来聊聊Python当中的命令行参数工具argparse。 命令行参数工具是我们非常常用的工具，比如当我们做实验希望调节参数的时候，如果参数都是通过硬编码写在代码当中的话，我们每次修改参数都需要修改对应的代码和逻辑显然这不太方便。比较好的办法就是把必要的参数设置成通过命令行传入的形式，这样我们只需要在运行的时候修改参数就可以了。 sys.argv 解析命令行传入参数最简单的办法就是通过sys.argv，sys.argv可以获取到我们通过命令行传入的参数。 import 阅读详情

argparse简介：

在argparse中，最常用的就是上述三部分了：创建一个ArgumentParser对象；使用add_argument()方法来为创建的ArgumentParser对象添加argument的解析规则；最后调用parse_args()来解析传入的内容，依据的是第二步制定的规则，生成的是一个Namespace对象，若未传参数给parse_args()，那么默认从sys.argv来获取命令行入参。

创建一个ArgumentParser：

函数原型为：

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)
1、prog：程序的名字，默认是argv[0]。若设置，则在帮助信息中，可以使用%(prog)s来作为格式化的引用（修改一处全局受用）。
2、usage：帮助信息的usage字段，描述程序的各种用法，默认情况下会依据add_argument()来自动生成。
3、description：一个简单描述程序主要干啥以及怎么用的字符段，默认为空。
4、epilog：optional arguments字符段之后的字符段，默认为空。
5、parents：继承的父parser，为了避免一些公共的内容重复定义，父parser在初始化时会设置add_help=False，这是为了防止出现父与子parser的-h冲突而抛出异常。
6、formatter_class：对于help输出进行格式化，除了输出的样式外，如果设置为ArgumentDefaultsHelpFormatter，则会自动在help输出中添加已定义的default值。
7、prefix_chars：options前的字符，默认为'-'，可以添加其他字符，如'-+'，但是如果没有包括'-'，那么对应的option如'-h'就无法解析。
8、fromfile_prefix_chars：有时会使用文件给parse_args()传入参数，为了能够识别文件字符串，如"demo.txt"，需要设置此值，如"@"，那么所有以此字符为开头的字符串都被当作是文件，所以传给parse_args()的参数应该是@demo.txt。在该文件中，一行只能有一个参数。如文件中的'-f\nbar'会被解析成['-f','bar']。
9、argument_default：一般情况下，默认值使用add_argument()来添加，或者使用set_defaults()设置一些键值对来添加。剩下一种情况就是设置此项（此处没看明白是咋回事）。
10、conflict_handler：解决在add_argument()阶段有冲突的option的依据策略，默认为error即抛出异常。一般情况下遇到冲突是抛出异常即可，但是如果设置了parents，那么需要重写父parser中的规则的时候，就需要将此项设置为resolve，但是重写是精确匹配的，如老规则定义了-h/--help，重写了-h，那么--help还是老规则。
11、add_help：是否添加-h/--helpoption，默认为True。为False时，是要做parent（其实可以设置子Parser重写）。默认是-h/--help，若prefix_chars中没有包含'-'，那么就以其中第一个字符作为代替。

调用add_argument()添加解析规则：

函数原型：

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

1、name or flags：是位置参数，则需要传入名字；要是可选参数，则需要进行定义，如'-f'，'--foo'。

2、action：定义传入的参数如何处理。

action='store'，默认取值，保存传入参数。
action='store_const'，需要添加const，意味着该argument的值不从命令行输入，而是取const的值。
action='store_true' or action='store_false'，'store_const'的特殊情形，意味着const的值为True或False。
action='append'，表示传入的值会作为一个列表的一项，意味着option可以在命令行中多次出现。
action='append_const'，传入列表的项由const定义，通常用在需要多个argument将值传入一个列表中的场景。
action='count'，输出argument出现的次数。
action='help'，已默认添加。
action='version'，需要定义version，使用时输出版本信息并退出。
自定义，通过定义一个argparse.Action子类来实现。实际上，上面的这些可选项都是通过这种形式定义的。

3、nargs：ArgumentParser对象通常将一个动作与一个命令行参数关联。nargs关键字参数将一个动作与不同数目的命令行参数关联在一起：

nargs=N，一个选项后可以跟多个参数（action='append'时，依然是一个选项后跟一个参数，只不过选项可以多次出现），参数的个数必须为N的值，这些参数会生成一个列表，当nargs=1时，会生成一个长度为1的列表。
nargs=?，如果没有在命令行中出现对应的项，则给对应的项赋值为default。特殊的是，对于可选项，如果命令行中出现了此可选项，但是之后没有跟随赋值参数，则此时给此可选项并不是赋值default的值，而是赋值const的值。
nargs=*，和N类似，但是没有规定列表长度。
nargs=+，和*类似，但是给对应的项当没有传入参数时，会报错error: too few arguments。
nargs=argparse.REMAINDER，所有剩余的参数，均转化为一个列表赋值给此项，通常用此方法来将剩余的参数传入另一个parser进行解析。如果nargs没有定义，则可传入参数的数量由action决定，通常情况下为一个，并且不会生成长度为一的列表。
4、const，一种是定义action='store_const'或action='append_const'时使用。一种是定义nargs='?'时，可选项出现在命令行中，但之后并没有跟随赋值的参数，作为默认值传给此可选项。
5、default：默认值。
如果是一个字符串，那么Parser解析的时候会将它作为命令行传入值，使用type的值来进行转换类型，但是如果不是的话，就会使用定义的值而不进行类型转换。如果设置了nargs='?'或nargs='*'，那么当没有参数赋值给该项时，会使用default定义的值。
而default=argparse.SUPPRESS时，则表示命令行中未出现某一项时，不会对它进行默认赋值。
6、type：用于类型检查和类型转换。
使用FileType可简化对文件的操作。还可以自定义函数，输入是一个字符串，输出是转换后的字符串。当设置choices的时，类型检查会变得容易，因为只需要在一个范围内比较即可。
7、choices：给定了取值范围，超出会报错。
当type也有定义时，会先使用type进行类型检查，所以choices中的取值必须符合type的定义，否则在parse_args()时会报错。任何支持in操作符的均可作为choices的赋值，所以字典，列表，集合，等等其他容器均都支持。
8、required：默认情况下，可选项（前面有'-'）被认为并不一定需要出现在命令行参数中，但是如果设置了required=True的话，则必须出现。此类设置违背人的常识，应避免使用。
9、help：帮助信息。
之前提到的%(prog)s可用于此处程序名的格式化，此外，还有%(default)s格式化default的值，%(type)s格式化type的值。
设置为argparse.SUPPRESS可不显示帮助信息。
10、metavar：在Parser生成帮助信息时，需要有字符代表需要传入的值。（这一段和dest相同，使用的就是dest的值）如果是位置参数，则用它本身代替；如果是可选参数，则使用它的大写来代替。使用metavar可替换默认的字符。
11、dest：大部分的选项都需要通过命令行来给其赋值，这些值的名字通过dest来定义，默认的规则如同metavar中所述。

调用parse_args()解析

函数原型：

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

将args转换为namespace对象的一个值。默认情况下，sys.argv赋值给args，一个空的Namespace对象会被创建。解析时，会对传入的参数进行检查，若不符合要求就会报错。一般情况下，会自动判断传入的值到底是一个可选参数，还是一个负数（都用'-'开头）。但有时位置参数的值必须是一个'-'开头的值，如'-f'，那么使用parser.parse_args(['--', '-f'])，'--'代表后续的所有传入值都需要看做是位置参数。parse_args()会返回填充好的Namespace对象

实例：

以faster rcnn代码中的命令行解析为例：

#coding=utf-8
import argparse
import sys

def parse_args():
  parser = argparse.ArgumentParser(description='Train a Fast R-CNN network')
  parser.add_argument('--cfg', dest='cfg_file',help='optional config file',default=None, type=str)
  parser.add_argument('--weight', dest='weight',help='initialize with pretrained model weights',type=str)
  parser.add_argument('--imdb', dest='imdb_name',help='dataset to train on',default='voc_2007_trainval', type=str)
  parser.add_argument('--imdbval', dest='imdbval_name',help='dataset to validate on',default='voc_2007_test', type=str)
  parser.add_argument('--iters', dest='max_iters',help='number of iterations to train',default=70000, type=int)
  parser.add_argument('--tag', dest='tag',help='tag of the model',default=None, type=str)
  parser.add_argument('--net', dest='net',help='vgg16, res50, res101, res152, mobile',default='res50', type=str)
  parser.add_argument('--set', dest='set_cfgs',help='set config keys', default=None,nargs=argparse.REMAINDER)

  if len(sys.argv) == 1:
    parser.print_help()
    sys.exit(1)
  args = parser.parse_args()
  return args

if __name__ == '__main__':
  args = parse_args()
  print(args)

将以上代码保存为test.py，然后在命令行输入：python test.py

结果为：

usage: test.py [-h] [--cfg CFG_FILE] [--weight WEIGHT] [--imdb IMDB_NAME]
[--imdbval IMDBVAL_NAME] [--iters MAX_ITERS] [--tag TAG]
[--net NET] [--set ...]

Train a Fast R-CNN network

optional arguments:
-h, --help show this help message and exit
--cfg CFG_FILE optional config file
--weight WEIGHT initialize with pretrained model weights
--imdb IMDB_NAME dataset to train on
--imdbval IMDBVAL_NAME
dataset to validate on
--iters MAX_ITERS number of iterations to train
--tag TAG tag of the model
--net NET vgg16, res50, res101, res152, mobile
--set ... set config keys

在命令行输入:

python test.py --weight data/imagenet_weights/vgg16.ckpt \
      		--imdb voc_2007_trainval  \
      		--imdbval voc_2007_test  \
      		--iters 7000   \
      		--cfg experiments/cfgs/vgg16.yml \
      		--net vgg16            \
      		--set ANCHOR_SCALES "[8,16,32]" ANCHOR_RATIOS "[0.5,1,2]" TRAIN.STEPSIZE "[50000]"

结果为：

Namespace(cfg_file='experiments/cfgs/vgg16.yml',imdb_name='voc_2007_trainval',imdbval_name='voc_2007_test', max_iters=7000, net='vgg16', set_cfgs=['ANCHOR_SCALES', '[8,16,32]', 'ANCHOR_RATIOS', '[0.5,1,2]', 'TRAIN.STEPSIZE', '[50000]'], tag=None, weight='data/imagenet_weights/vgg16.ckpt')

参考：

https://www.jianshu.com/p/820b74a2f113
https://www.cnblogs.com/xiaofeiIDO/p/6154953.html

收录于