python中argparse

最新推荐文章于 2025-06-13 10:05:47 发布

星辰_风清扬

最新推荐文章于 2025-06-13 10:05:47 发布

阅读量1k

点赞数

CC 4.0 BY-SA版权

文章标签： python 开发语言后端

原文链接：https://blog.youkuaiyun.com/yy_diego/article/details/82851661

本文介绍了Python内置的命令行参数解析库argparse的使用方法，包括基本框架、choices限制参数选择和nargs指定参数数量。示例代码展示了如何创建参数解析器，定义参数并获取用户输入，以及处理参数值的选择和数量约束。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

关于argparse网上的资料好多，搞明白后自己整理下，方便以后查看。argparse 是python自带的命令行参数解析包，可以用来方便地读取命令行参数。它的使用也比较简单。
1.基本框架
下面是采用argparse从命令行获取用户名，该python的文件名为：fun_test.py

import argparse

def main():
    parser = argparse.ArgumentParser(description="Demo of argparse")
    parser.add_argument('-n','--name', default=' Li ')
    parser.add_argument('-y','--year', default='20')
    args = parser.parse_args()
    print(args)
    name = args.name
    year = args.year
    print('Hello {}  {}'.format(name,year))

if __name__ == '__main__':
    main()

在命令行执行如下命令：

$ python print_name.py --name Great

输出：
$ Hello Great 20

在上面的代码中，我们先导入了argparse这个包，然后包中的ArgumentParser类生成一个parser对象（好多博客中把这个叫做参数解析器），其中的description描述这个参数解析器是干什么的，当我们在命令行显示帮助信息的时候会看到description描述的信息。
接着我们通过对象的add_argument函数来增加参数。这里我们增加了两个参数name和year，其中'-n','--name'表示同一个参数，default参数表示我们在运行命令时若没有提供参数，程序会将此值当做参数值。执行结果如上图所示。
最后采用对象的parse_args获取解析的参数，由上图可以看到，Namespace中有两个属性（也叫成员）这里要注意个问题，当'-'和'--'同时出现的时候，系统默认后者为参数名，前者不是，但是在命令行输入的时候没有这个区分接下来就是打印参数信息了。
当执行命令python fun_test.py -n Wang --year '26'结果如下：

python fun_test.py -n Wang --year '26'

输出：
$ Hello Wang 26

2. `choices`：参数值只能从几个选项里面选择

如下面的代码：

# file-name: choices.py
import argparse

def get_parser():
    parser = argparse.ArgumentParser(
        description='choices demo')
    parser.add_argument('-arch', required=True, choices=['alexnet', 'vgg'])

    return parser

if __name__ == '__main__':
    parser = get_parser()
    args = parser.parse_args()
    print('the arch of CNN is '.format(args.arch))

如果像下面这样执行会报错：
$ python choices.py -arch resnet
usage: choices.py [-h] -arch {alexnet,vgg}
choices.py: error: argument -arch: invalid choice: 'resnet' (choose from 'alexnet', 'vgg')
因为我们所给的-arch参数resnet不在备选的choices之中，所以会报错

`3. nargs`：设置参数在使用可以提供的个数

使用方式如下：

parser.add_argument('-name', nargs=x)
其中x的候选值和含义如下：

值    含义
N     参数的绝对个数（例如：3）
'?'   0或1个参数
'*'   0或所有参数
'+'   所有，并且至少一个参数

如下例子：

# file-name: nargs.py
import argparse

def get_parser():
    parser = argparse.ArgumentParser(
        description='nargs demo')
    parser.add_argument('-name', required=True, nargs='+')

    return parser


if __name__ == '__main__':
    parser = get_parser()
    args = parser.parse_args()
    names = ', '.join(args.name)
    print('Hello to {}'.format(names))

执行命令和结果如下：

$ python nargs.py -name A B C
Hello to A, B, C