argparse基本用法

古城微笑少年丶 2022-05-10 05:56 125阅读 0赞

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

[更多参数介绍可以参看这个链接][Link 1]

[70]: /images/20220510/ba975a6417f543d793ec61b637d6055d.png
[70 1]: /images/20220510/e83983cf6739401fa0d1acc20b054678.png
[70 2]: /images/20220510/214e0d9db63b44789f2f4d4513743fdd.png
[Link 1]: http://vra.github.io/2017/12/02/argparse-usage/