Flask框架——蓝图、flask-script

目录

蓝图

flask-scrip

在上篇文章我们学习了Flask框架——模板复用（继承、包含、宏），这篇文章我们来学习Flask框架——蓝图、命令行工具flask-script。

蓝图

在一个完整的Flask应用程序中，肯定会有很多视图函数，例如：用Flask框架写的购物网站中，会有和用户、商品、评论相关联的视图函数，把所有视图函数都放在一个py文件中肯定是不可取的，管理起来会非常不方便。

这时我们可以把视图函数进行模块化处理，把用户视图函数、商品视图函数、评论视图函数分为用户模块、商品模块和评论模块。Flask框架内置了一个模块化处理的类——Blueprint蓝图。

Blueprint蓝图是一种组织一组相关视图及其他代码的方式。与把视图及其他代码直接注册到应用的方式不同，蓝图方式是把它们注册到蓝图，然后在工厂函数中把蓝图注册到应用。

简单来说就把视图函数按功能分为很多个小模块，这些小模块调用Blueprint类后称为蓝图，一般情况下，我们都是把蓝图放在包里，把蓝图注册到app应用中，这样就实现了模块化处理，如下图所示：

接下来我们通过Flask项目来演示如何使用创建、使用蓝图。

创建Flask项目目录如下所示：

这里创建一个apps包，在apps包中我们创建了goods、user包分别用来存放goods视图函数文件和user视图函数文件。

用user包为例，在user包中创建名为view的py文件，该文件用来编写视图函数，view.py示例代码如下所示：

from flask import Blueprint
user_bp= Blueprint('user',__name__)  #蓝图实例化对象

@user_bp.route('/hello')   #路由装饰器 
def hello_world():     #视图函数
    return 'hello world'   #返回hello world字符串

使用Blueprint()方法获取到蓝图对象user_bp，和之间的Flask程序路由装饰器不同，该路由装饰器为：

蓝图实例化对象.route()

注意：apps包的init.py初始化文件与static静态文件夹、templates模板文件夹不在同一级，所以需要在Blueprint()方法中传递template_folder和static_folder参数，告诉该视图函数在哪里找静态文件夹和模板文件夹，代码如下所示：

user_bp= Blueprint('user',__name__,template_folder='../templates',static_folder='../static')

但一般来说，我们不会在Blueprint()方法中传递template_folder和static_folder，一般在apps包中的init.py初始化文件中传入template_folder和static_folder参数，示例代码如下所示：

from flask import Flask
from apps.user.view import user_bp

def create_app():
 #设置静态文件夹和模板文件夹的路径
    app=Flask(__name__,template_folder='../templates',static_folder='../static')
    app.register_blueprint(user_bp)  #注册蓝图
    return app    #返回Flask对象

在init.py初始化文件中自定义一个create_app()方法，并在方法中使用Flask，获取Flask类实例对象app，这样我们就不需要在启动文件app.py文件中使用Flask，启动app.py文件就很简洁了，使用register_blueprint()方法注册蓝图。

启动文件app.py代码如下所示：

from apps import create_app

app=create_app()   #调用init.py初始文件的create_app()方法

if __name__ == '__main__':
    app.run()

启动文件很简洁，就调用create_app()和一个启动run()方法。

启动Flask项目，访问http://127.0.0.1:5000/hello，网页就会显示hello world。

这样我们就成功使用了蓝图。

flask-script

flask-script是一个支持自定义命令的工具，为Flask程序添加了一个命令行解析器，可以让程序从命令行直接执行相应的程序。

flask-script支持在Flask中编写外部脚本，这包括运行开发服务器、定制python-shell、设置数据库的脚本、cronjobs和其他属于web应用程序本身之外的命令行任务。

其安装方式如下所示：

pip install flask-script

将flask-script继承在Flask项目app.py中，其代码如下所示：

from flask import Flask
from flask_script import Manager   #导入Manager方法

app = Flask(__name__)

manager = Manager(app)  # 将命令行绑定在app应用中

@app.route('/')
def index():
    return 'hello world'

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

我们依旧在命令行中执行下面代码来启动flask程序的app，代码如下所示：

app.py

运行结果如下图所示：

我们发现flask程序没有被启动，这时因为什么呢？

运行结果图中的大概意思是执行代码app.py中后面缺少了一些命令，这些命令可以是shell、runserver，也可以通过--help来获取命令的帮助。其中：

• shell：在Flask程序中运行一个Python脚本；

• runserver：启动flask程序服务器。

由于我们通过Manager()方法将命令行绑定在app应用中，所以需要命令行执行下面代码来启动flask程序：

app.py runserver

运行结果如下所示：

这样就成功启动了flask程序了，接下来我们看看app.py runserver后面还可以接什么命令，如下图所示：

在app.py runserver后面可以接以下命令：

[-?] [-h HOST] [-p PORT] [--threaded] [--processes PROCESSES] [--passthrough-errors] [-d] [-D] [-r] [-R] [--ssl-crt SSL_CRT] [--ssl-key SSL_KEY]

这里就不一一解释每个命令的作用了。

我们举个简单的例子，修改flask服务的端口号，命令行执行代码如下所示：

app.py runserver -p 8080

这样就成功修改了flask服务的端口号。

除了flask-script自带的shell，runserver命令之外，我们还可以自定义flask-script命令，其代码如下所示：

from flask import Flask
from flask_script import Manager

app = Flask(__name__)

manager=Manager(app)

@manager.command
def welcome():    #自定义flask-script
    print('welcome')

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

这里我们通过manager.command()来添加welcome到flask-scrip命令中，命令行输入app.py，如下图所示：

我们发现在图中多了welcome这个命令，命令行执行app.py welcome，如下图所示：

这样就成功自定义命令了。

好了，Flask框架——蓝图、命令行工具flask-script就讲到这里了，下篇文章学习Flask框架——数据库配置及迁移同步，感谢观看！！！

公众号：白巧克力LIN

- END -