FastAPI的小兄弟,开发命令行工具更给力
FastAPI的开发组织叫做tiangolo,他家除了FastAPI外,还有另一个项目也非常好用,叫做typer。
三年前,我写过一篇文章一日一技:快速实现Python 命令行参数介绍另一个命令行工具fire. 而typer做得比fire还要好。
首先使用pip来安装它:python3 -m pip install typer
函数参数等于命令行参数
我们首先来看看typer怎么使用。创建一个example_1.py文件,写入如下代码。import typer
def main(name: str, salary: int):
print(f"{name}月薪{salary}元")
if __name__ == "__main__":
typer.run(main)
直接运行,Python会报错:
使用参数--help可以查看这个脚本的命令行参数:
于是我们根据这里的提示,输入正确的参数,从而正常运行程序:
子命令与自动补全更好用
假设我们有一个神经网络的程序,其中的入口函数代码如下:def train_data(train_folder: str, test_folder: str, rate: float = 0.8):
"""
训练人脸检测模型
"""
print(f"使用文件夹{train_folder}中的数据进行训练")
print(f"使用{test_folder}中的数据用来验证训练效果,确保准确率>{rate}")
return True
def predict(folder: str):
"""
使用训练好的模型预测
"""
print(f"对文件夹{folder}中的数据进行预测。")
显然,这个程序可以用来训练数据,也可以用来预测数据,所以有两种不同的命令,每一种命令有不同的参数。
这种情况下,使用typer非常方便,只需要加两个装饰器就可以了:
运行效果如下图所示:
输入具体的子命令,还可以查看每个子命令的参数:
因此,我可以使用两个不同的子命令来运行程序:
你以为这样就完了?我们再安装它的一个辅助工具typer-cli,还可以做更多事情:python3 -m pip install typer-cli
typer --install-completion
有了这个东西,我们运行程序可以这样写:typer example_2.py run 子命令 参数1 参数2 --可选参数1 可选参数1的值
例如:
并且,typer可以帮我们可以实现自动补全:
输入typer example_2.py run然后按下Tab键,自动告诉你可以输入哪些子命令,如下图所示:
除此之外,如果你的命令行程序只有一个命令,那么你甚至只需要写一个函数,连typer都不需要导入,就可以使用typer来运行:
自动生成文档也简单
我们知道,FastAPI自动生成接口文档的功能非常好用。typer作为它的兄弟,也继承了这个高级功能。我们来看看:import typer
app = typer.Typer(help="人脸检测模型")
@app.command
def train_data(train_folder: str, test_folder: str, rate: float = 0.8):
"""
训练人脸检测模型
"""
print(f"使用文件夹{train_folder}中的数据进行训练")
print(f"使用{test_folder}中的数据用来验证训练效果,确保准确率>{rate}")
return True
@app.command
def predict(folder: str):
"""
使用训练好的模型预测
"""
print(f"对文件夹{folder}中的数据进行预测。")
运行命令:typer main.py utils docs --name "python3 main.py" --output readme.md
自动在当前文件夹生成一个readme.md文件。我们使用任何能够渲染Markdown的软件打开这个文档,可以看到文档内容如下:
这样一来,我们不需要额外花心思去维护文档,只需要在修改完代码、增删新的命令或者参数以后,运行这个命令,就可以把文档自动更新。
百元耳机之王Tribit趣倍FlyBuds1测评TWS千千万,今天给大家带来的是Tribit趣倍FlyBuds1的测评。说到Tribit趣倍这个品牌,大家可能不太了解,说实话,小编也是第一次接触到这个品牌,之前也只看过一些新闻报
君子兰的冬季换盆技巧君子兰原产南非热带雨林地区,喜欢疏松透气好的微酸性的腐殖土壤。因此,在土壤配比方面建议用腐熟橡树叶40,松针20,沙粒20,木炭颗粒10,火山岩10的比例混合使用。大盆养死花,小盆
墨兰和蕙兰的不同养护技巧墨兰属于地生兰,因此喜欢生长在优质疏松的土壤环境,我们常会选择腐叶土进行养护,腐叶土就是山林里面的土壤,里面含有丰富的矿物质元素。墨兰根茎是属于假鳞茎,因此土壤过于积水板结时都不利
兰花龙根的养护技巧兰花开花后经过授粉,也是可以结出种子的,这些种子在适合的自然条件下也可以萌发,有种子萌发的小苗都可称之为龙根苗。种子萌发的时候,先萌发根状茎叫做龙根,根状茎萌发到地面,首先形成假鳞
大花蕙兰的开花后养护技巧大花蕙兰没必要分苗,一般是削老苗,开花以后把最老的苗削去。大花蕙兰是4年苗才开花,从兰株上可以分辨出1234各个年份的苗,将最早两年的老苗都去掉,只留第三和第四年的壮苗。耗肥量特别
如何养发财树才能枝繁叶茂?想将发财树养得旺盛,土壤的选择是至关重要的。最好选择富含有机质疏松透气保水性能良好的土壤,不要选择黏重的土壤。充足的光照也是发财树长得旺盛的关键。如果光照不充足会使发财树的叶子发黄
兰花的家庭养护技巧养兰环境要通透敞亮,通风性要好,能在室外养就在室外养,不要在室内闷着,室外露养兰草会长得健壮许多,还不容易生病。兰花基本都是肉质根系,对于透气性要求非常高,土壤要疏松,不能板结,更
小米超大环拍照之王小米10至尊纪念版凝聚了众多的黑科技,比如120倍超长变焦,120瓦的快充,120HZ的高刷屏幕。50瓦的无线快充以及10W反向充电那么小米10至尊纪念版值不值得购买,我带大家了解
红米k40新机5G高端旗舰介绍。红米手机从红米1发展到最新的红米k40,每一代都有超高的性价比,这一代直接用上了旗舰处理器,吸引了不少人关注。红米k40发布于2021年2月25号,采用6。67英寸OLED打孔屏幕
小鹏G3将迎来改款?外观神似P7,预估下半年上市就在近日,国内媒体曝光了一张新款小鹏G3的谍照图。在谍照图我们可以看出,新款小鹏G3的外观造型改变得非常明显,看上去与小鹏P7的前脸十分神似,看起来这套家族式设计将会用在后续的新车
稳重大气硬派当道!新款北京越野BJ30到店实拍说起国产越野SUV,可能你会想到这2年的热门车型坦克300,但实际上较早一批做越野的自主车企,想必各位绝对不陌生北京汽车越野BJ系列。作为第一批主打越野性能的自主车企,且在越野这个