flask-script模塊的具體使用
1 作用
通過(guò) flask-script 可以以命令的形式,執(zhí)行 flask 語(yǔ)句。
提供向 Flask 插入外部腳本的功能,如 運(yùn)行一個(gè)開(kāi)發(fā)服務(wù)器、運(yùn)行 shell、執(zhí)行數(shù)據(jù)庫(kù)腳本。
2 安裝
pip install flask-script
3 所有要運(yùn)行的命令都放在 manager.py 中
from flask import Flask from flask_script import Manager, Command from loguru import logger # [ 生成一個(gè) Flask 實(shí)例 ] app = Flask(__name__) # [ Manager 構(gòu)造方法,只接受一個(gè)參數(shù), # 就是 Flask 實(shí)例,Manager 負(fù)責(zé)追蹤整個(gè) 命令 的處理過(guò)程 ] manager = Manager(app)
4 三種方式 創(chuàng)建命令
4.1 方式一 創(chuàng)建 Command子類(lèi)
# 定義要執(zhí)行的命令類(lèi)型 Hello 繼承 Command
class Hello(Command):
# 重寫(xiě) Command 類(lèi)的 run() 方法
def run(self):
''' 要執(zhí)行的命令 '''
logger.info('sub class of Command')
if __name__ == '__main__':
'''
將 hello 命令加入到 manager ,
第一個(gè)參數(shù)為自己起的的命令簡(jiǎn)稱(chēng),
第二個(gè)參數(shù)為 Command 子類(lèi) Hello 的實(shí)例
'''
manager.add_command('hello', Hello())
manager.run()
在 cmd 執(zhí)行 python manager.py hello [ hello 就是自己的 命令的簡(jiǎn)稱(chēng) ]
這樣就會(huì)打印出 sub class of Command
4.2 方式二 使用裝飾器 @manager.command
'''
@manager.command 其實(shí) manager 就是上面初始化出來(lái)的 Manager 類(lèi)的實(shí)例,
如果 Manager 類(lèi)的實(shí)例名稱(chēng)為 manager_1 ,則裝飾器也要改成 @manager_1.command
'''
'''
使用 裝飾器 @manager.command 后,命令的簡(jiǎn)稱(chēng)就是 函數(shù)的名字 hello_command,
在 __main__ 中 就不需要 在 通過(guò) manager.add_command() 將 命令簡(jiǎn)稱(chēng)加入到 command 實(shí)例中了
'''
@manager.command
def hello_command():
logger.info('@manager.command')
if __name__ == '__main__':
'''
在 __main__ 中 就不需要 在 通過(guò) manager.add_command() 將 命令簡(jiǎn)稱(chēng)加入到 command 實(shí)例中了
'''
manager.run()
在 cmd 執(zhí)行 python manager.py hello_command [ hello_command 就是自己的 命令的簡(jiǎn)稱(chēng) ]
這樣就會(huì)打印出 @manager.command
4.3 方式三 使用裝飾器 @manager.option
'''
-u 為命令參數(shù)的 簡(jiǎn)寫(xiě),--username 為命令參數(shù)的 全稱(chēng)
(類(lèi)似于 Linux 命令的參數(shù),參數(shù)簡(jiǎn)寫(xiě) 為一個(gè) -,參數(shù)全稱(chēng)為 -- ),
無(wú)論是參數(shù)的 簡(jiǎn)寫(xiě)、還是 全稱(chēng) 都必須以 - 開(kāi)頭,但是 全稱(chēng)也可以只以 一個(gè) - 開(kāi)頭,
但建議以 兩個(gè) - 開(kāi)頭,因?yàn)楦暇幋a規(guī)范,dest 的值必須與 hello_option 函數(shù)(也就是命令)的 入?yún)⒚?稱(chēng) 完全相同,因?yàn)?dest 就是表示這個(gè)參數(shù)值,傳遞給 hello_option 命令函數(shù)的那個(gè)入?yún)⒌?;default 表示
參數(shù)的默認(rèn)值,也就是如果執(zhí)行 python manager.py hello_option 執(zhí)行命令時(shí),不帶參數(shù),就用參數(shù)的默認(rèn)
值
'''
@manager.option('-u', '--username', dest='username', default='zhangsan')
@manager.option('-p', '--password', dest='password', default='123456')
def hello_option(username, password):
logger.info('@manage.option')
logger.info(f'username = {username}, password = {password}')
if __name__ == '__main__':
'''
在 __main__ 中 就不需要 在 通過(guò) manager.add_command() 將 命令簡(jiǎn)稱(chēng)加入到 command 實(shí)例中了
'''
到此這篇關(guān)于flask-script模塊的具體使用的文章就介紹到這了,更多相關(guān)flask-script模塊內(nèi)容請(qǐng)搜索本站以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持本站!
版權(quán)聲明:本站文章來(lái)源標(biāo)注為YINGSOO的內(nèi)容版權(quán)均為本站所有,歡迎引用、轉(zhuǎn)載,請(qǐng)保持原文完整并注明來(lái)源及原文鏈接。禁止復(fù)制或仿造本網(wǎng)站,禁止在非maisonbaluchon.cn所屬的服務(wù)器上建立鏡像,否則將依法追究法律責(zé)任。本站部分內(nèi)容來(lái)源于網(wǎng)友推薦、互聯(lián)網(wǎng)收集整理而來(lái),僅供學(xué)習(xí)參考,不代表本站立場(chǎng),如有內(nèi)容涉嫌侵權(quán),請(qǐng)聯(lián)系alex-e#qq.com處理。
關(guān)注官方微信