Flask 入门(二)

2023-10-18

字数统计: 1.4k字 | 阅读时长≈ 6分

原文地址：[Python web 开发实战]

即插视图

即插视图的灵感来自 Django 的基于类而不是函数的通用视图方式，这样的视图就可以支持继承了。视图类型有两种类型。

标准视图

标准视图需要继承 flask.views.View, 必须实现 dispatch_request。看一个例子：
app_view.py

from flask import Flask, request, render_template
from flask.views import View

app = Flask(__name__, template_folder='../../templates')


class BaseView(View):
    def get_template_name(self):
        raise NotImplementedError()
    
    def render_template(self, context):
        return render_template(self.get_template_name(), **context)
    
    def dispatch_request(self):
        if request.method != 'GET':
            return 'UNSUPPORTED'
        
        context = {'users': self.get_users()}
        return self.render_template(context)


class UserView(BaseView):
    
    def get_template_name(self):
        return 'chapter3/section1/users.html'
    
    def get_users(self):
        return [{
            'username': 'fake',
            'avatar': 'http://lorempixel.com/100/100/nature'
        }]


app.add_url_rule('/users', view_func=UserView.as_view('userview'))


if __name__ == '__main__':
    app.run(host='0.0.0.0', port=9000)

模板存放在 ~/web_develop/templates 下，使用 __name__ 来获取模板目录，template_folder 是相对于 app.py 文件的，需要设置成 ‘../../templates’ 才能找到正确的模板目录。

基于调度方法的视图

flask.views.MethodView 对于每个 HTTP 方法执行不同的函数（映射到对应方法的小写的同名方法上），这对 RESTful API 由其有用，看一个例子：
app_api.py

from flask import Flask, jsonify
from flask.views import MethodView

app = Flask(__name__)


class UserAPI(MethodView):
    
    def get(self):
        return jsonify({
            'username': 'fake',
            'avatar': 'http://lorempixel.com/100/100/nature/'
        })
    
    def post(self):
        return 'UNSUPPORTED'


app.add_url_rule('/user', view_func=UserAPI.as_view('userview'))


if __name__ == '__main__':
    app.run(host='0.0.0.0', port=9000)

通过装饰 as_view 的返回值来实现对于视图的装饰功能，常用于权限的检查，登录验证等：

def user_required(f):
    def decorator(*args, **kwargs):
        if not g.user:
            abort(401)
        return f(*args, **kwargs)
    return decorator

view = user_required(UserAPI.as_view('users'))
app.add_url_rule('/users/', view_func=view)

从 Flask 0.8 开始，还可以通过继承 MethodView 的类中添加 decorators 属性来实现对视图的装饰：

1 2	class UserAPI(MethodView): decorators = [user_required]

蓝图

蓝图实现了应用的模块化，使用蓝图让应用层次清晰，开发者可以更容易的开发和维护项目。蓝图通常作用于相同的 URL 前缀，比如 /user:id, /user/profile 这样的地址，都以 /user 开头，那么他们就可以放在一个模块中。看一个最简单的示例：
user.py

from flask import Blueprint

bp = Blueprint('user', __name__, url_prefix='/user')


@bp.route('/')
def index():
    return "User's Index page"

每个模块都会暴露一个全局变量 bp，再看主程序 (app_bp.py):
app_bp.py

from flask import Flask

app = Flask(__name__)

app.register_blueprint(user.bp)


if __name__ == '__main__':
    app.run(host='0.0.0.0', port=9000)

使用 register_blueprint 注册模块，如果想去掉模块，只需要去掉对应的注册语句即可。

子域名

现在许多 SaaS 应用为用户提供一个子域名来访问，可以借助 subdomain 来实现同样的功能：
app_subdomain.py

from flask import Flask, g

app = Flask(__name__)
app.config['SERVER_NAME'] = 'example.com:9000'

@app.url_value_preprocessor
def get_site(endpoint, values):
    g.site = values.pop('subdomain')

@app.route('/', subdomain='<subdomain>')
def index():
    return g.site

if __name__ == '__main__':
    app.run(host='0.0.0.0', port=9000)

在 /etc/hosts 中添加域名绑定：

1	127.0.0.1 a.example.com b.example.com

现在验证它：

1 2	htto http://b.example.com:9000 --print b # b 表示只输出响应的主体 b

命令行接口

在 Flask 0.11 之前，启动的应用的端口，主机地址以及是否开启 DEBUG 模式，都需要在代码中明确指定，一个比较好的方式是使用第三方扩展 Flask-Script 管理。从 Flask 0.11 开始，Flask 集成了 Click，现在可以直接在命令行执行 flask 命令启动 Flask 应用了：

1
2
3

export FLASK_APP=chapter3/section1/hello.py
export FLASK_DEBUG=1
flask run -h 0.0.0.0 -p 9000

这种命令行启动的方式要灵活得多，命令 flask 还支持 shell 子命令：

% flask shell
Python 3.7.7 (default, Apr 11 2020, 23:54:18) 
[Clang 11.0.3 (clang-1103.0.32.29)] on darwin
App: section1.hello [production]
Instance: /Users/wanwu/PycharmProjects/flask_tutorail/chapter3/instance
>>> app
<Flask 'section1.hello'>

新的方案甚至能够替换 Flask-Script。现在我们基于 flask.cli 模块添加两个子命令：
app_cli.py

第一个子命令 initdb，用来初始化数据库，这里没有实际的逻辑，只是为了演示 click 的使用方法：

import click

from flask import Flask

app = Flask(__name__)

@app.cli.command()
def initdb():
    click.echo('Init the db')

先指定 FLASK_APP 变量

1	export FLASK_APP=chapter3/section1/app_cli.py

现在就可以使用 initdb 了：

1 2	> flask initdb Init the db

再复杂些，实现一个叫做 new_shell 的子命令，它使用 Python 环境（除非没有安装 IPython或者强制要求使用默认的交互环境）：

import click
import sys
import code

from flask import Flask
from flask.cli import with_appcontext


app = Flask(__name__)


try:
    import IPython
    has_ipython = True
except ImportError:
    has_ipython = False


def plain_shell(user_ns, banner):
    sys.exit(code.interact(banner=banner, local=user_ns))


def ipython_shell(user_ns, banner):
    IPython.embed(banner1=banner, user_ns=user_ns)


@app.cli.command('new_shell', short_help='Runs a shell in the app context.')
@click.option('--plain', help='Use Plain Shell', is_flag=True)
@with_appcontext
def shell_command(plain):
    from flask.globals import _app_ctx_stack
    app = _app_ctx_stack.stop.app
    banner = 'Python %s on %s \nAPP: %s%s\nInstance: %s' % (
        sys.version,
        sys.platform,
        app.import_name,
        app.debug and ' [debug]' or '',
        app.instance_path,
    )
    user_ns = app.make_shell_context()
    use_plain_shell = not has_ipython or plain
    if use_plain_shell:
        plain_shell(user_ns, banner)
    else:
        ipython_shell(user_ns, banner)

其中，app.cli.command 用来指定子命令的名字和帮助信息，click.option 给子命令添加参数，由于 new_shell 需要使用 app 这个上下文，所以需要添加 with_appcontext 这个装饰器。