0%

Flask——程序的基本结构

初始化


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

1
2
from flask import Flask
app = Flask(__name__)

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

将构造函数的name参数传给Flask程序,Flask可以用这个参数决定程序的根目录,以便稍后能够找到相对于程序根目录的资源文件位置。

路由与视图函数


客户端(例如Web浏览器)把请求发送给Web服务器,Web服务器再把请求发送给Flask程序实例。程序实例需要知道对每个URL请求运行哪些代码,所以保存了一个URL到Python函数的映射关系。处理URL和函数之间关系的程序称为路由

在Flask程序中定义路由的最简便的方式,是使用程序实例提供的app.route修饰器,把修饰器的函数注册为路由。例如:

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

修饰器是Python语言的标准特性,可以使用不同的方式修改函数的行为。惯常用法是使用修饰器把函数注册为事件的处理程序。

前例把index()函数注册为程序根地址的处理程序。如果部署程序的服务器域名为www.example.com,在浏览器中访问http://www.example.com后,会触发服务器执行index()函数。这个函数的返回值称为**响应**,是客户端接收到的内容。如果客户端是Web浏览器,响应就是显示给用户查看的文档。

像index()这样的函数称为视图函数(view function)。视图函数返回的响应可以是包含HTML的简单字符串,也可以是复杂的表单。

另外,Flask还支持包含可变部分的URL,只需在route修饰器中使用特殊的句法即可。例如:

1
2
3
@app.route('/user/<name>')
def user(name):
return '<h1>Hello,%s!</h1>' %name

尖括号中的内容是动态部分,任何能匹配静态部分的URL都会映射到这个路由上。调用试图函数时,Flask会将动态部分作为参数传入函数。在这个视图函数中,参数用于生成针对个人的欢迎消息。路由中的动态部分默认使用字符串,不过也可使用类型定义。例如,路由/user/int:id只会匹配动态片段id为整数的URL。Flask支持在路由中使用intfloatpath类型。path类型也是字符串,但不把斜线视作分隔符,而将其当做动态片段的一部分。

启动服务器


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

1
2
if __name__ == '__main__':
app.run(debug=True,host='0.0.0.0')

__name__=='__main__'是Python的惯常用法,在这里确保直接执行这个脚本时才启动开发Web服务器。如果这个脚本由其他脚本引入,程序假定父级脚本会启动不同的服务器,因此不会执行app.run()。

服务器启动后,会进入轮询,等待并处理请求。轮询会一直运行,直到程序停止,比如按Ctrl-C键。

有一些选项参数可被app.run()函数接受用于设置Web服务器的操作模式。在开发过程中启动调试模式会带来一些便利,比如说激活调试器和重载程序。要想启动调试模式,我们可以把debug参数设为True。

一个完整的程序


前面介绍了Flask Web程序的不同组成部分,现在尝试开发一个完整的程序,代码如下:

1
2
3
4
5
6
7
8
9
from flask import Flask
app = Flask(__name__)

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

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

使用下述命令启动程序:

# python run.py 
 * Running on http://0.0.0.0:5000/ (Press CTRL+C to quit)
 * Restarting with stat
 * Debugger is active!
 * Debugger pin code: 953-142-708

程序运行后,打开浏览器,在地址栏中输入http://:5000,能访问到Hello World页面,如果输入了其他地址,程序将不知道如何处理,因此会向浏览器返回错误代码404。

继续向上述代码中添加一个动态路由,访问这个地址http://:5000/user/xautlmx,你会看到一则针对个人的欢迎消息。

1
2
3
4
5
6
7
8
9
10
11
12
13
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,host='0.0.0.0')

请求-响应循环


程序和请求上下文

Flask从客户端收到请求时,要让视图函数能访问一些对象,这样才能处理请求。请求对象就是一个很好的例子,它封装了客户端发送的HTTP请求。

要想让视图函数能够访问请求对象,一个显而易见的方式是将其作为参数传入视图函数,不过这会导致程序中的每个视图函数都增加一个参数。除了访问请求对象,如果视图函数在处理请求时还要访问其他对象,情况会变得更糟。

为了避免大量可有可无的参数把视图函数弄得一团糟,Flask使用上下文临时把某些对象变为全局可访问。有了上下文,就可以写出下面的视图函数:

1
2
3
4
5
6
7
8
9
10
from flask import Flask,request
app = Flask(__name__)

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

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

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

线程是可单独管理的最小指令集。进程经常使用多个活动线程,有时还会共享内存或文件句柄等资源。多线程Web服务器会创建一个线程池,再从线程池中选择一个线程用于处理接收到的请求。

在Flask中有两种上下文:程序上下文请求上下文

变量名 上下文 说明
current_app 程序上下文 当前激活程序的程序实例
g 程序上下文 处理请求时用作临时存储的对象。每次请求都会重设这个变量
request 请求上下文 请求对象,封装了客户端发出的HTTP请求中的内容
session 请求上下文 用户会话,用于存储请求之间需要“记住”的值的字典

Flask在分发请求之前激活(或推送)程序和请求上下文,请求处理完成后再将其删除。程序上下文被推送后,就可以在线程中使用current_app和g变量。类似地,请求上下文被推送后,就可以使用request和session变量。如果使用这些变量时我们没有激活程序上下文或请求上下文,就会导致错误。

下面这个Python shell会话演示了程序上下文的使用方法(run是上述程序Flask程序的文件名):

>>> from run import app
>>> from flask import current_app
>>> current_app.name
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "/root/myproject/venv/lib/python2.7/site-packages/werkzeug/local.py", line 343, in __getattr__
    return getattr(self._get_current_object(), name)
  File "/root/myproject/venv/lib/python2.7/site-packages/werkzeug/local.py", line 302, in _get_current_object
    return self.__local()
  File "/root/myproject/venv/lib/python2.7/site-packages/flask/globals.py", line 34, in _find_app
    raise RuntimeError('working outside of application context')
RuntimeError: working outside of application context
>>> app_ctx = app.app_context()
>>> app_ctx.push()
>>> current_app.name
'run'
>>> app_ctx.pop()

请求调度

程序收到客户端发来的请求时,要找到处理该请求的视图函数。为了完成这个任务,Flask会在程序的URL映射中查找请求的URL。URL映射是URL和视图函数之间的对应关系。Flask使用app.route修饰器或者非修饰器形式的app.add_url_rule()生成映射。

要想查看Flask程序中的URL映射是什么样子,我们可以在Python shell中检查为run.py生成的映射。测试之前,确保激活了虚拟环境:

# python
>>> from run import app
>>> app.url_map
Map([<Rule '/' (HEAD, OPTIONS, GET) -> index>,
 <Rule '/static/<filename>' (HEAD, OPTIONS, GET) -> static>])

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

URL映射中的HEAD、OPTIONS、GET是请求方法,由路由进行处理。Flask为每个路由都指定了请求方法,这样不同的请求方法发送到相同的URL上时,会使用不同的视图函数进行处理。HEAD和OPTIONS方法由Flask自动处理,因此可以说,在这个程序中,URL映射中的2个路由都使用GET方法。

请求钩子

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

请求钩子使用修饰器实现。Flask至此以下4种钩子:

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

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

响应

Flask调用视图函数后,会将其返回值作为响应的内容。大多数情况下,响应就是一个简单的字符串,作为HTML页面回送客户端。

但HTTP协议需要的不仅是作为请求响应的字符串。HTTP响应中一个很重要的部分是状态码,Flask默认设为200,这个代码表明请求已经被成功处理。

如果视图函数返回的响应需要使用不同的状态码,那么可以把数字代码作为第二个返回值,添加到响应文本之后。例如,下述视图函数返回一个404状态码,表示请求无效:

1
2
3
4
5
6
7
8
9
10
from flask import Flask,request
app = Flask(__name__)

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

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

视图函数返回的响应还可以接受第三个参数,这是一个由首部(header)组成的字典,可以添加到HTTP响应中。一般情况下并不需要这么做。

如果不想返回由1个、2个或3个值组成的元组,Flask试图函数还可以返回Response对象。make_response()函数可接受1个、2个或3个参数(和视图函数的返回值一样),并返回一个Response对象。有时我们需要在视图函数中进行这种转换,然后在响应对象上调用各种方法,进一步设置响应。下例创建了一个响应对象,然后设置了cookie:

1
2
3
4
5
6
7
8
9
10
11
from flask import Flask,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,host='0.0.0.0')

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

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

1
2
3
4
5
6
7
8
9
from flask import Flask,redirect
app = Flask(__name__)

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

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

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

1
2
3
4
5
6
7
8
9
10
11
12
from flask import Flask,abort
app = Flask(__name__)

@app.route('/user/<id>')
def get_user(id):
if id:
return '<h1>Hello %s</h1>' %id
else:
abort(404)

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

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

Flask扩展


Flask被设计为可扩展形式,故而没有提供一些重要的功能,例如数据库和用户认证,所以开发者可以自由选择最合适程序的包,或者按需求自行开发。

社区成员开发了大量不同用途的扩展,如果这还不能满足需求,你还可使用所有Python标准包或代码库。

使用Flask-Script支持命令行选项

Flask的开发Web服务器支持很多启动设置选项,但只能在脚本中作为参数传给app.run()函数。这种方式并不十分方便,传递设置选项的理想方式是使用命令行参数。

Flask-Script是一个Flask扩展,为Flask程序添加了一个命令行解释器。Flask-Script自带了一组常用选项,而且还支持自定义命令。

Flask-Script扩展使用pip安装:

(venv) [root@server1 myproject]# pip install flask-script

然后更改程序:

1
2
3
4
5
6
7
8
9
10
11
from flask import Flask,abort
from flask.ext.script import Manager
app = Flask(__name__)
manager = Manager(app)

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

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

专为Flask开发的扩展都包含在flask.ext命名空间下。Flask-Script输出了一个名为Manager的类,可从flask.ext.script中引入。

这个扩展的初始化方法也适用于其他很多扩展:把程序实例作为参数传给构造函数,初始化主类的实例。创建的对象可以在各个扩展中使用。在这里,服务器由manager.run()启动,启动后就能解析命令行了。

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

# python run.py
usage: run.py [-?] {shell,runserver} ...

positional arguments:
  {shell,runserver}
    shell            Runs a Python shell inside Flask application context.
    runserver        Runs the Flask development server i.e. app.run()

optional arguments:
  -?, --help         show this help message and exit

shell命令用于在程序的上下文中启动Python shell会话。可以使用这个会话中运行维护任务或测试,还可以调试异常。下面列举几个常用的命令行选项和参数:

  • runserver 以调试模式启动Web服务器
  • runserver –host 指定Web服务器再哪个网络接口上监听来自客户端的连接
  • runserver –port 指定Web服务器监听的端口

参考书籍:《Flask Web开发——基于Python的Web应用开发实战》


- - - - - - - - - 本文结束啦感谢您阅读 - - - - - - - - -