1、helloworld程序
安装flask
pip3 install flask
编写hello.py
from flask import Flask
app = Flask(__name__)
@app.route('/')
def index():
return "<h1>hello world! <h1>"
if __name__ == '__main__':
app.run(debug=True)
运行
python3 hello.py
在浏览器中打开
http://127.0.0.1:5000/
这这么几行代码就能写一个简单的服务了
2、 程序和请求上下文
Flask 从客户端收到请求时,要让视图函数能访问一些对象,这样才能处理请求。请求对
象就是一个很好的例子,它封装了客户端发送的 HTTP 请求。 要想让视图函数能够访问请求对象,一个显而易见的方式是将其作为参数传入视图函数,
不过这会导致程序中的每个视图函数都增加一个参数。除了访问请求对象,如果视图函数
程序的基本结构 | 11
在处理请求时还要访问其他对象,情况会变得更糟。
为了避免大量可有可无的参数把视图函数弄得一团糟,Flask 使用上下文临时把某些对象 变为全局可访问。有了上下文,就可以写出下面的视图函数:
@app.route('/')
def index():
user_agent = request.headers.get('User-Agent')
return '<p>Your browser is %s</p>' % user_agent
注意在这个视图函数中我们如何把 request 当作全局变量使用。事实上,request 不可能是 全局变量。试想,在多线程服务器中,多个线程同时处理不同客户端发送的不同请求时, 每个线程看到的 request 对象必然不同。Falsk 使用上下文让特定的变量在一个线程中全局 可访问,与此同时却不会干扰其他线程。
下图为上下文中的全局变量
3、 请求钩子
有时在处理请求之前或之后执行代码会很有用。例如,在请求开始时,我们可能需要创 建数据库连接或者认证发起请求的用户。为了避免在每个视图函数中都使用重复的代码, Flask 提供了注册通用函数的功能,注册的函数可在请求被分发到视图函数之前或之后 调用。
请求钩子使用修饰器实现。Flask 支持以下 4 种钩子。
• before_first_request:注册一个函数,在处理第一个请求之前运行。
• before_request:注册一个函数,在每次请求之前运行。
• after_request:注册一个函数,如果没有未处理的异常抛出,在每次请求之后运行。
• teardown_request:注册一个函数,即使有未处理的异常抛出,也在每次请求之后运行。
在请求钩子函数和视图函数之间共享数据一般使用上下文全局变量 g。例如,before_ request 处理程序可以从数据库中加载已登录用户,并将其保存到 g.user 中。随后调用视 图函数时,视图函数再使用 g.user 获取用户。
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 make_response
@app.route('/')
def index():
response = make_response('<h1>This document carries a cookie!</h1>')
response.set_cookie('answer', '42')
return response
有一种名为重定向的特殊响应类型。这种响应没有页面文档,只告诉浏览器一个新地址用 以加载新页面。重定向经常在 Web 表单中使用
重定向经常使用 302 状态码表示,指向的地址由 Location 首部提供。重定向响应可以使用 3 个值形式的返回值生成,也可在 Response 对象中设定。不过,由于使用频繁,Flask 提 供了 redirect() 辅助函数,用于生成这种响应:
from flask import redirect
@app.route('/')
def index():
return redirect('http://www.baidu.com')
还有一种特殊的响应由 abort 函数生成,用于处理错误。在下面这个例子中,如果 URL 中
动态参数 id 对应的用户不存在,就返回状态码 404:
from flask import abort
@app.route('/user/<id>')
def get_user(id):
user = load_user(id)
if not user:
abort(404)
return '<h1>Hello, %s</h1>' % user.name
注意,abort 不会把控制权交还给调用它的函数,而是抛出异常把控制权交给 Web 服 务器。
5、 Flask扩展
Flask 被设计为可扩展形式,故而没有提供一些重要的功能,例如数据库和用户认证,所
以开发者可以自由选择最适合程序的包,或者按需求自行开发。
社区成员开发了大量不同用途的扩展,如果这还不能满足需求,你还可使用所有 Python 标 准包或代码库。为了让你知道如何把扩展整合到程序中,接下来我们将在 hello.py 中添加 一个扩展,使用命令行参数增强程序的功能。
使用Flask-Script支持命令行选项
Flask 的开发 Web 服务器支持很多启动设置选项,但只能在脚本中作为参数传给 app.run()
函数。这种方式并不十分方便,传递设置选项的理想方式是使用命令行参数。
Flask-Script 是一个 Flask 扩展,为 Flask 程序添加了一个命令行解析器。Flask-Script 自带 了一组常用选项,而且还支持自定义命令。
安装flask-script
pip3 install flask-script
使用 Flask-Script
from flask_script import Manager
manager = Manager(app)
# ...
if __name__ == '__main__':
manager.run()
这个扩展的初始化方法也适用于其他很多扩展:把程序实例作为参数传给构造函数,初始 化主类的实例。创建的对象可以在各个扩展中使用。在这里,服务器由 manager.run() 启 动,启动后就能解析命令行了
使用命令行启动
python hello.py runserver --help
下面是一些帮助信息
-h HOST, --host HOST
-p PORT, --port PORT
--threaded
--processes PROCESSES
--passthrough-errors
-d, --debug enable the Werkzeug debugger (DO NOT use in production
code)
-D, --no-debug disable the Werkzeug debugger
-r, --reload monitor Python files for changes (not
100{'option_strings': ['-r', '--reload'], 'dest':
'use_reloader', 'nargs': 0, 'const': True, 'default':
None, 'type': None, 'choices': None, 'required':
False, 'help': 'monitor Python files for changes (not
100% safe for production use)', 'metavar': None,
'container': <argparse._ArgumentGroup object at
0x10982aa20>, 'prog': 'hello.py runserver'}afe for
production use)
-R, --no-reload do not monitor Python files for changes
--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 地址。
网友评论