Python Fire:更加灵活的命令行参数
之前介绍过Python
的Fire
库,一个用来生成命令行工具的的库。
请参考:Python Fire:自动生成命令行接口
今天,针对命令行参数,补充两种更加灵活的设置方式。
1. *args 型参数
*args
型的参数可以接受任意长度的参数。
比如,模拟一个学校发送通知的功能:
import fire
def notions(school, *names):
for name in names:
print(f"[{school} 通知] hello {name}")
if __name__ == "__main__":
fire.Fire(notions)
使用起来很灵活,
$ python.exe .\fire-sample.py NJ大学 小红 小李 小张 小华
[NJ大学 通知] hello 小红
[NJ大学 通知] hello 小李
[NJ大学 通知] hello 小张
[NJ大学 通知] hello 小华
$ python.exe .\fire-sample.py --school NJ大学 小红 小李 小张
[NJ大学 通知] hello 小红
[NJ大学 通知] hello 小李
[NJ大学 通知] hello 小张
$ python.exe .\fire-sample.py --school NJ大学 小红 小李 小张 小华
[NJ大学 通知] hello 小红
[NJ大学 通知] hello 小李
[NJ大学 通知] hello 小张
[NJ大学 通知] hello 小华
$ python.exe .\fire-sample.py 小红 小李 --school NJ大学 小张 小华
[NJ大学 通知] hello 小红
[NJ大学 通知] hello 小李
[NJ大学 通知] hello 小张
[NJ大学 通知] hello 小华
从上面使用的示例可看出,
- 可以不输入参数名称(比如第一个例子),按照顺序第一参数赋值给
school
,其余的赋值给*names
。 *names
参数支持不定长度的值school
参数指定参数名的话,可以放在任意的位置(比如上面第四个例子)。
2. **kwargs 型参数
**kwargs
型参数也是不定长度的,和*args
型参数不同的地方在于,
使用**kwargs
型参数时,需要指定参数名称。
比如,模拟一个显示学生成绩的功能:
import fire
def scores(cls, **students):
for k, v in students.items():
print(f"[{cls} 成绩] {k}: {v}")
if __name__ == "__main__":
fire.Fire(scores)
使用示例如下:
$ python .\fire-sample.py 初三1班 --小红 98 --小李 89 --小王 100
[初三1班 成绩] 小红: 98
[初三1班 成绩] 小李: 89
[初三1班 成绩] 小王: 100
$ python .\fire-sample.py --小红 98 --小李 89 --小王 100 初三1班
[初三1班 成绩] 小红: 98
[初三1班 成绩] 小李: 89
[初三1班 成绩] 小王: 100
$ python .\fire-sample.py --小红 98 --小李 89 --小王 100 --cls 初三1班
[初三1班 成绩] 小红: 98
[初三1班 成绩] 小李: 89
[初三1班 成绩] 小王: 100
cls
参数可以不指定名称,也可以放在任意位置上。**students
参数则必须指定参数名称,但参数名称不固定,参数的个数也不固定。
3. 总结
*args
型和**kwargs
型参数可以有效的缓解命令行工具灵活性不足的问题。
开发命令行工具时,根据自己的场景,使用这两种类型的参数可让命令行工具的接口更加简洁灵活。