一、传入一个参数
import argparse
# 创建一个命令行参数解析器
parser = argparse.ArgumentParser(description='命令行中传入一个数字')
# 往解析器里面添加参数
parser.add_argument('integer', type=str, help='传入的数字')
# 得到命令行传入的参数
args = parser.parse_args()
print(args.integer)
二、传入多个参数
import argparse
# 创建一个命令行参数解析器
parser = argparse.ArgumentParser(description='命令行中传入一个数字')
# 往解析器里面添加参数
parser.add_argument('integer', type=str, nargs='+', help='传入的数字')
# 得到命令行传入的参数
args = parser.parse_args()
print(args.integer) # 以列表形式返回
注:
- nargs='+': 传入一个或多个参数
- nargs='*': 传入零个或多个参数
- nargs='?': 传入零个或一个参数
三、改变数据类型
# 可通过更改type参数修改数据类型
parser.add_argument('integer', type=str, nargs='+', help='传入的数字')
四、可选参数(关键字参数)
注:参数前面加双横杠"- -"表示这个参数是可选参数,即在命令行中可以以键值得形式指定,顺序可以打乱。
import argparse
parser = argparse.ArgumentParser(description='姓名')
parser.add_argument('--family', type=str, help='姓')
parser.add_argument('--name', type=str, help='名')
args = parser.parse_args()
#打印姓名
print(args.family+args.name)
命令行命令:
python XXX.py --family 张 --name 三 or
python XXX.py --name 三 --family 张
五、参数默认值
通过default指定默认值。
parser.add_argument('--family', default='李', type=str, help='姓')
parser.add_argument('--name', type=str, help='名')
六、参数解析
parse_args()只能解析已知参数,parse_known_args()兼容未知参数并返回。
import argparse
parser = argparse.ArgumentParser(description='姓名')
parser.add_argument('--family', type=str,help='姓')
parser.add_argument('--name', type=str,help='名')
args = parser.parse_args()
# args, dynamic_args = parser.parse_known_args()
print(args)
print(dynamic_args)
命令行示例:
python XXX.py --family 张 --name 三 --test hello
结果:
args = parser.parse_args() # 报错, error: unrecognized arguments: --test 5
args, dynamic_args = parser.parse_known_args() # 成功返回