Flask系列(九)flask-script組件

Flask Script擴展提供向Flask插入外部腳本的功能,包括運行一個開發用的服務器,一個定製的Python shell,設置數據庫的腳本,cronjobs,及其餘運行在web應用以外的命令行任務;使得腳本和系統分開;python

Flask Script和Flask自己的工做方式相似,只需定義和添加從命令行中被Manager實例調用的命令;web

官方文檔:http://flask-script.readthedocs.io/en/latest/shell

1、建立並運行命令

首先,建立一個Python模板運行命令腳本,可起名爲manager.py;數據庫

在該文件中,必須有一個Manager實例,Manager類追蹤全部在命令行中調用的命令和處理過程的調用運行狀況;flask

Manager只有一個參數——Flask實例,也能夠是一個函數或其餘的返回Flask實例;服務器

調用manager.run()啓動Manager實例接收命令行中的命令;app

#-*-coding:utf8-*-  
from flask_script import Manager  
from debug import app  
  
manager = Manager(app)  
  
if __name__ == '__main__':  
    manager.run()  

其次,建立並加入命令;函數

有三種方法建立命令,即建立Command子類、使用@command修飾符、使用@option修飾符;url

第一種——建立Command子類spa

Command子類必須定義一個run方法;

舉例:建立Hello命令,並將Hello命令加入Manager實例;

from flask_script import Manager  ,Server
from flask_script import Command  
from debug import app  
  
manager = Manager(app)  


class Hello(Command):  
    'hello world'  
    def run(self):  
        print 'hello world'  

#自定義命令一:
manager.add_command('hello', Hello())  
# 自定義命令二:

manager.add_command("runserver", Server()) #命令是runserver
if __name__ == '__main__':  
    manager.run()  

執行以下命令:

python manager.py hello
> hello world

 python manager.py runserver 
> hello world

第二種——使用Command實例的@command修飾符

#-*-coding:utf8-*-  
from flask_script import Manager  
from debug import app  
  
manager = Manager(app)  
 
@manager.command  
def hello():  
    'hello world'  
    print 'hello world'  
  
if __name__ == '__main__':  
    manager.run()  

該方法建立命令的運行方式和Command類建立的運行方式相同;

python manager.py hello
> hello world

第三種——使用Command實例的@option修飾符

複雜狀況下,建議使用@option;

能夠有多個@option選項參數;

from flask_script import Manager  
from debug import app  
  
manager = Manager(app)  
 
@manager.option('-n', '--name', dest='name', help='Your name', default='world')    #命令既能夠用-n,也能夠用--name,dest="name"用戶輸入的命令的名字做爲參數傳給了函數中的name
@manager.option('-u', '--url', dest='url', default='www.csdn.com')  #命令既能夠用-u,也能夠用--url,dest="url"用戶輸入的命令的url做爲參數傳給了函數中的url

def hello(name, url):  
'hello world or hello <setting name>'  
    print 'hello', name  
    print url  
  
if __name__ == '__main__':  
    manager.run()  

運行方式以下:

python manager.py hello
>hello world
>www.csdn.com

python manager.py hello -n sissiy -u www.sissiy.com
> hello sissiy
>www.sissiy.com

python manager.py hello -name sissiy -url www.sissiy.com> hello sissiy>www.sissiy.com

相關文章
相關標籤/搜索