import argparse 命令行传递参数代码参数分离

我会带着你远行 2023-02-17 02:45 33阅读 0赞

**argparse 是python自带的命令行参数解析包，可以用来方便地读取命令行参数，当你的代码需要频繁地修改参数的时候，使用这个工具可以将参数和代码分离开来，让你的代码更简洁，适用范围更广。**  
该例子基本概括我们常用的代码参数分类要求。

import argparse
    def main():
    	# 参数解析器
        parser = argparse.ArgumentParser(description="Demo of argparse")
        
        # 增加参数
        parser.add_argument("parg_first") 
        # 注意设置了这个位置参数，就需要代码执行时向第一个参数传值，
        # 不然会报错，一般不建议使用位置参数，除非需要输入的参数较少 
        # 位置参数,第一个参数赋值给parg_first 
    
        parser.add_argument('-n','--name', default='Mr.Li')  
        #可选参数：通过一个-来指定的短参数，如-h；通过–来指定的长参数，如- -help
        # 这里设置'--name'的含义是接受-n "name" 同时也接受--n "name"输入格式，以及--name “name”
    
        parser.add_argument('-y','--year', default='20')
        parser.add_argument("-digit", type=int, help="输入数字") 
        # parser.add_argument("-de", type=int, help="输入数字") 
        # 上面这行将会出错,因为与上面的-digit在使用-d作为标识时有冲突,因此一般定义都要定义-y --year两种方式,这样就不会出错
        # 如果没有定义default,数据参数为None
        # 通过 -echo xxx声明的参数，为int类型, help参数是当运行Python .py -h时的提示信息
    
        # 获取解析参数
        # Namespace(digit=None, name='zjq', parg_first='woshi', year='2020')
        args = parser.parse_args() 
        print(args)
    
        # 获取解析参数转化为字典 
        # {'parg_first': 'woshi', 'name': 'zjq', 'year': '2020', 'digit': None}
        args_dict = vars(parser.parse_args()) 
        print(args_dict)
    
        name = args.name
        year = args.year
        parg_first = args.parg_first
    
        print(f'Hello {name} {year} {parg_first}')
        # Hello zjq 2020 woshi
        
    if __name__ == '__main__':
        main()

zjq@DESKTOP-O28RVV3:9_测试文件夹$ python argparse_test.py woshi -n zjq -y 2020 -d 256
    Namespace(digit=256, name='zjq', parg_first='woshi', year='2020')
    {'parg_first': 'woshi', 'name': 'zjq', 'year': '2020', 'digit': 256}
    Hello zjq  2020 woshi
    zjq@DESKTOP-O28RVV3:9_测试文件夹$

总结:建议使用添加参数格式如下  
`parser.add_argument("-d","-digit", default=2020,type=int, help="输入数字")`

下面的例子解释命令执行方式

import argparse
    def main():
    	# 参数解析器
        parser = argparse.ArgumentParser(description="Demo of argparse")
        
        # 增加参数
        parser.add_argument("-d", type=int, default=2020, help="数字功能")             
        parser.add_argument("-name", "--na", default="zjq", help="名字")
        # 获取解析参数
        args = parser.parse_args() 
        print(args)
    
        # 获取解析参数转化为字典 
        args_dict = vars(parser.parse_args()) 
        print(args_dict)
    
        print(args.d, "="*5, args.na) 
        # 如果定义了--, 则以引用--为准, 但是在命令执行时
        # 可以依然可以使用-n 或者-na 或者-name
        
    if __name__ == '__main__':
        main()
    
    ''' zjq@DESKTOP-O28RVV3:9_测试文件夹$ python argparse_test.py -d 256 -n zj2 Namespace(d=256, na='zj2') {'d': 256, 'na': 'zj2'} 256 ===== zj2 zjq@DESKTOP-O28RVV3:9_测试文件夹$ python argparse_test.py -d 256 -na zj2 Namespace(d=256, na='zj2') {'d': 256, 'na': 'zj2'} 256 ===== zj2 zjq@DESKTOP-O28RVV3:9_测试文件夹$ python argparse_test.py -d 256 -name zj2 Namespace(d=256, na='zj2') {'d': 256, 'na': 'zj2'} 256 ===== zj2 zjq@DESKTOP-O28RVV3:9_测试文件夹$ '''