Flask Web书本章节代码执行

第二章节代码

2.1初始化 

所有 Flask 程序都必须创建一个程序实例。Web 服务器使用一种名为 Web 服务器网关接口
(Web Server Gateway Interface,WSGI)的协议,把接收自客户端的所有请求都转交给这
个对象处理。程序实例是 Flask 类的对象,经常使用下述代码创建:

from flask import Flask
app = Flask(__name__)

Flask 类的构造函数只有一个必须指定的参数,即程序主模块或包的名字。在大多数程序
中,Python 的 __name__ 变量就是所需的值。

2.2路由和视图函数

客户端(例如 Web 浏览器)把请求发送给 Web 服务器,Web 服务器再把请求发送给 Flask
程序实例。程序实例需要知道对每个 URL 请求运行哪些代码,所以保存了一个 URL 到
Python 函数的映射关系。处理 URL 和函数之间关系的程序称为路由。
在 Flask 程序中定义路由的最简便方式,是使用程序实例提供的 app.route 修饰器,把修
饰的函数注册为路由。下面的例子说明了如何使用这个修饰器声明路由:

@app.route('/')
def index():
        return '<h1>Hello World!</h1>'

2.3启动服务器

程序实例用 run 方法启动 Flask 集成的开发 Web 服务器:

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

        __name__== ' __main__ ' 是 Python 的惯常用法,在这里确保直接执行这个脚本时才启动开发
Web 服务器。如果这个脚本由其他脚本引入,程序假定父级脚本会启动不同的服务器,因
此不会执行 app.run() 。
        服务器启动后,会进入轮询,等待并处理请求。轮询会一直运行,直到程序停止,比如按
Ctrl-C 键。
        有一些选项参数可被 app.run() 函数接受用于设置 Web 服务器的操作模式。在开发过程中
启用调试模式会带来一些便利,比如说激活调试器和重载程序。要想启用调试模式,我们
可以把 debug 参数设为 True 。

2.4 hello.py

要想运行这个程序,请确保激活了你之前创建的虚拟环境,并在其中安装了 Flask。现在
打开 Web 浏览器,在地址栏中输入 http://127.0.0.1:5000/。

from flask import Flask
app = Flask(__name__)

@app.route('/')
def index():
    return '<h1>Hello World!</h1>'
if __name__ == '__main__':
    app.run(debug=True)

用刚才的执行结果去到终端(要先启动虚拟环境)和对应的文件夹执行对应名称的py.exe,执行结果与网页的一致

(venv) $ python hello.py
* Running on http://127.0.0.1:5000/
* Restarting with reloader

hello.py含动态路由

from flask import Flask
app = Flask(__name__)

@app.route('/')
def index():
    return '<h1>Hello World!</h1>'

@app.route('/user/<name>')

def user(name):
    return '<h1>Hello, %s!</h1>' % name

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

需要在http://127.0.0.1:5000/ 后面添加user/Bela才能出现下面的结果

2.5请求-响应循环

2.5.1程序和请求上下文

        Flask 从客户端收到请求时,要让视图函数能访问一些对象,这样才能处理请求。请求对
象就是一个很好的例子,它封装了客户端发送的 HTTP 请求。
        要想让视图函数能够访问请求对象,一个显而易见的方式是将其作为参数传入视图函数,
不过这会导致程序中的每个视图函数都增加一个参数。除了访问请求对象,如果视图函数在处理请求时还要访问其他对象,情况会变得更糟。
        为了避免大量可有可无的参数把视图函数弄得一团糟,Flask 使用上下文临时把某些对象
变为全局可访问。有了上下文,就可以写出下面的视图函数:

from flask import request
@app.route('/')
def index():
        user_agent = request.headers.get('User-Agent')
        return '<p>Your browser is %s</p>' % user_agent

注意在这个视图函数中我们如何把 request 当作全局变量使用。事实上, request 不可能是
全局变量。试想,在多线程服务器中,多个线程同时处理不同客户端发送的不同请求时,
每个线程看到的 request 对象必然不同。Falsk 使用上下文让特定的变量在一个线程中全局
可访问,与此同时却不会干扰其他线程。

运行时由于直接放进去会显示@app.route('/')没有定义,因此需要加入一些东西。在开头加入app的定义,以及加上if语句的结尾

from flask import Flask
from flask import request
app = Flask(__name__)

@app.route('/')
def index():
    user_agent = request.headers.get('User-Agent')
    return '<p>Your browser is %s</p>' % user_agent

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

结果示意图:

在 Flask 中有两种上下文:程序上下文和请求上下文。表 2-1 列出了这两种上下文提供的
变量。
表2-1 Flask上下文全局变量

Flask 在分发请求之前激活(或推送)程序和请求上下文,请求处理完成后再将其删除。程
序上下文被推送后,就可以在线程中使用 current_app 和 g 变量。类似地,请求上下文被
推送后,就可以使用 request 和 session 变量。如果使用这些变量时我们没有激活程序上
下文或请求上下文,就会导致错误。如果你不知道为什么这 4 个上下文变量如此有用,先
别担心,后面的章节会详细说明。
下面这个 Python shell 会话演示了程序上下文的使用方法:

>>> from hello import app
>>> from flask import current_app
>>> current_app.name

Traceback (most recent call last):
...
RuntimeError: working outside of application context
>>> app_ctx = app.app_context()
>>> app_ctx.push()
>>> current_app.name
'hello'
>>> app_ctx.pop()

在这个例子中,没激活程序上下文之前就调用 current_app.name 会导致错误,但推送完上
下文之后就可以调用了。注意,在程序实例上调用 app.app_context() 可获得一个程序上
下文。

结果示意图:

2.5.2请求调度

程序收到客户端发来的请求时,要找到处理该请求的视图函数。为了完成这个任务,Flask
会在程序的 URL 映射中查找请求的 URL。URL 映射是 URL 和视图函数之间的对应关系。
Flask 使用 app.route 修饰器或者非修饰器形式的 app.add_url_rule() 生成映射。
要想查看 Flask 程序中的 URL 映射是什么样子,我们可以在 Python shell 中检查为 hello.py
生成的映射。测试之前,请确保你激活了虚拟环境:

(venv) $ python
>>> from hello import app
>>> app.url_map
Map([<Rule '/' (HEAD, OPTIONS, GET) -> index>,
<Rule '/static/<filename>' (HEAD, OPTIONS, GET) -> static>,
<Rule '/user/<name>' (HEAD, OPTIONS, GET) -> user>])

/ 和 /user/<name> 路由在程序中使用 app.route 修饰器定义。 /static/<filename> 路由是
Flask 添加的特殊路由,用于访问静态文件。

Python shell 中检查为 hello.py生成的映射结果示意图:

2.5.3请求钩子

有时在处理请求之前或之后执行代码会很有用。例如,在请求开始时,我们可能需要创
建数据库连接或者认证发起请求的用户。为了避免在每个视图函数中都使用重复的代码,
Flask 提供了注册通用函数的功能,注册的函数可在请求被分发到视图函数之前或之后
调用。
请求钩子使用修饰器实现。Flask 支持以下 4 种钩子。

• before_first_request:注册一个函数,在处理第一个请求之前运行。

• before_request:注册一个函数,在每次请求之前运行。
•after_request :注册一个函数,如果没有未处理的异常抛出,在每次请求之后运行。
•teardown_request  :注册一个函数,即使有未处理的异常抛出,也在每次请求之后运行。

在请求钩子函数和视图函数之间共享数据一般使用上下文全局变量 g 。例如, before_
request 处理程序可以从数据库中加载已登录用户,并将其保存到 g.user 中。随后调用视
图函数时,视图函数再使用 g.user 获取用户。

 2.5.4响应

Flask 调用视图函数后,会将其返回值作为响应的内容。大多数情况下,响应就是一个简
单的字符串,作为 HTML 页面回送客户端。
但 HTTP 协议需要的不仅是作为请求响应的字符串。HTTP 响应中一个很重要的部分是状
态码,Flask 默认设为 200,这个代码表明请求已经被成功处理。
如果视图函数返回的响应需要使用不同的状态码,那么可以把数字代码作为第二个返回
值,添加到响应文本之后。例如,下述视图函数返回一个 400 状态码,表示请求无效:

@app.route('/')
def index():
        return '<h1>Bad Request</h1>', 400

        视图函数返回的响应还可接受第三个参数,这是一个由首部(header)组成的字典,可以
添加到 HTTP 响应中。一般情况下并不需要这么做,不过你会在第 14 章看到一个例子。
        如果不想返回由 1 个、2 个或 3 个值组成的元组,Flask 视图函数还可以返回 Response 对
象。 make_response() 函数可接受 1 个、2 个或 3 个参数(和视图函数的返回值一样),并
返回一个 Response 对象。有时我们需要在视图函数中进行这种转换,然后在响应对象上调
用各种方法,进一步设置响应。下例创建了一个响应对象,然后设置了 cookie:

from flask import Flask
from flask import request
app = Flask(__name__)

@app.route('/')
def index():
    return '<h1>Bad Request</h1>', 400

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

结果示意图:

视图函数返回的响应还可接受第三个参数,这是一个由首部(header)组成的字典,可以
添加到 HTTP 响应中。一般情况下并不需要这么做,不过你会在第 14 章看到一个例子。
如果不想返回由 1 个、2 个或 3 个值组成的元组,Flask 视图函数还可以返回 Response 对
象。 make_response() 函数可接受 1 个、2 个或 3 个参数(和视图函数的返回值一样),并
返回一个 Response 对象。有时我们需要在视图函数中进行这种转换,然后在响应对象上调
用各种方法,进一步设置响应。下例创建了一个响应对象,然后设置了 cookie:

from flask import Flask
from flask import make_response
app = Flask(__name__)

@app.route('/')
def index():
    response = make_response('<h1>This document carries a cookie!</h1>')
    response.set_cookie('answer', '42')
    return response

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

结果示意图: 

有一种名为重定向的特殊响应类型。这种响应没有页面文档,只告诉浏览器一个新地址用
以加载新页面。

重定向经常使用 302 状态码表示,指向的地址由 Location 首部提供。重定向响应可以使用
3 个值形式的返回值生成,也可在 Response 对象中设定。不过,由于使用频繁,Flask 提
供了 redirect() 辅助函数,用于生成这种响应:

from flask import Flask
from flask import redirect
app = Flask(__name__)

@app.route('/')
@app.route('/')
def index():
    return redirect('http://www.example.com')

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

结果示意图:

还有一种特殊的响应由 abort 函数生成,用于处理错误。在下面这个例子中,如果 URL 中
动态参数 id 对应的用户不存在,就返回状态码 404:

from flask import Flask
from flask import abort
app = Flask(__name__)

@app.route('/user/<id>')
def get_user(id):
    user = load_user(id)
    if not user:
        abort(404)
        return '<h1>Hello, %s</h1>' % user.name

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

结果示意图:

注意, abort 不会把控制权交还给调用它的函数,而是抛出异常把控制权交给 Web 服
务器。

2.6flask扩展

Flask 的开发 Web 服务器支持很多启动设置选项,但只能在脚本中作为参数传给 app.run()
函数。这种方式并不十分方便,传递设置选项的理想方式是使用命令行参数。
Flask-Script 是一个 Flask 扩展,为 Flask 程序添加了一个命令行解析器。Flask-Script 自带
了一组常用选项,而且还支持自定义命令。
Flask-Script 扩展使用 pip 安装:

(venv) $ pip install flask-script

示例 2-3 显示了把命令行解析功能添加到 hello.py 程序中时需要修改的地方。

示例 2-3 hello.py:使用 Flask-Script

from flask.ext.script import Manager
manager = Manager(app)
# ...
if __name__ == '__main__':
manager.run()

 专为 Flask 开发的扩展都暴漏在 flask.ext 命名空间下。Flask-Script 输出了一个名为
Manager 的类,可从 flask.ext.script 中引入。
这个扩展的初始化方法也适用于其他很多扩展:把程序实例作为参数传给构造函数,初始
化主类的实例。创建的对象可以在各个扩展中使用。在这里,服务器由 manager.run() 启
动,启动后就能解析命令行了。

这样修改之后,程序可以使用一组基本命令行选项。现在运行 hello.py,会显示一个用法
消息:

$ python hello.py
usage: hello.py [-h] {shell,runserver} ...
positional arguments:
        {shell,runserver}
                shell 在 Flask 应用上下文中运行 Python shell
                runserver 运行 Flask 开发服务器:app.run()
optional arguments:
        -h, --help 显示帮助信息并退出

shell 命令用于在程序的上下文中启动 Python shell 会话。你可以使用这个会话中运行维护
任务或测试,还可调试异常。
顾名思义, runserver 命令用来启动 Web 服务器。运行 python hello.py runserver 将以调
试模式启动 Web 服务器,但是我们还有很多选项可用:

(venv) $ python hello.py runserver --help
usage: hello.py runserver [-h] [-t HOST] [-p PORT] [--threaded]
                                        [--processes PROCESSES] [--passthrough-errors] [-d]
                                        [-r]

运行 Flask 开发服务器:app.run()

optional arguments:
-h, --help 显示帮助信息并退出
-t HOST, --host HOST
-p PORT, --port PORT
--threaded
--processes PROCESSES
--passthrough-errors
-d, --no-debug
-r, --no-reload

--host 参数是个很有用的选项,它告诉 Web 服务器在哪个网络接口上监听来自客户端的
连接。默认情况下,Flask 开发 Web 服务器监听 localhost 上的连接,所以只接受来自服
务器所在计算机发起的连接。下述命令让 Web 服务器监听公共网络接口上的连接,允许同
网中的其他计算机连接服务器:

(venv) $ python hello.py runserver --host 0.0.0.0
* Running on http://0.0.0.0:5000/
* Restarting with reloader

现在,Web 服务器可使用 http://a.b.c.d:5000/ 网络中的任一台电脑进行访问,其中“a.b.c.d”
是服务器所在计算机的外网 IP 地址。

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 1
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值