Flask-Script

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

　　Flask Script和Flask本身的工作方式類似，只需定義和添加從命令行中被Manager實例調用的命令；

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

 

1 創建並運行命令

首先，創建一個Python模板運行命令腳本，可起名為manager.py；

在該文件中，必須有一個Manager實例，Manager類追蹤所有在命令行中調用的命令和處理過程的調用運行情況；

Manager只有一個參數——Flask實例，也可以是一個函數或其他的返回Flask實例；

調用manager.run()啟動Manager實例接收命令行中的命令；

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

其次，創建並加入命令；

三中創建命令的方式：創建Command子類、使用@command修飾符、使用@option修飾符

一、創建Command子類

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修飾符

#-*-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()  

"""
python manager.py hello
> hello world
"""

 

三、使用@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
"""

 

 

使用flask-script自定義的manage.py文件

#!/usr/bin/env python
# -*- coding:utf-8 -*-
import os
from flask_script import Manager, Server
from app import create_app

app = create_app()
manager = Manager(app)


@manager.command
def custom(arg):
    """
    自定義命令
    python manage.py custom 123
    :param arg:
    :return:
    """
    print(arg)


@manager.option('-n', '--name', dest='name')
@manager.option('-u', '--url', dest='url')
def cmd(name, url):
    """
    自定義命令
    執行： python manage.py  cmd -n wupeiqi -u http://www.oldboyedu.com
    :param name:
    :param url:
    :return:
    """
    print(name, url)


@manager.command
def import_news(path):
    """
    批量導入
    :param name:
    :param url:
    :return:
    """
    import xlrd
    from xlrd.book import Book
    from xlrd.sheet import Sheet
    from xlrd.sheet import Cell
    workbook = xlrd.open_workbook(path)
    sheet_names = workbook.sheet_names()
    # sheet = workbook.sheet_by_name('工作表1')
    sheet = workbook.sheet_by_index(0)

    # 循環Excel文件的所有行
    for row in sheet.get_rows():
        # print(row)
        # 循環一行的所有列
        for col in row:
            # 獲取一個單元格中的值
            print(col.value,end=';')
        print('')

# 自定義命令
manager.add_command("runserver", Server())

if __name__ == "__main__":
    manager.run()