Flask从入门到精通之flask程序入门

Posted 木易森林

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了Flask从入门到精通之flask程序入门相关的知识,希望对你有一定的参考价值。

初始化

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

from flask import Flask
app = FLask(__name__)

Flask类的构造函数只有一个必须指定的参数,即程序主模块或则包的名称。。在大多数程序中,Python 的__name__ 变量就是所需的值。将构造函数的name 参数传给Flask 程序,这一点可能会让Flask 开发新手心生迷惑。Flask 用这个参数决定程序的根目录,以便稍后能够找到相对于程序根目录的资源文件位置。

路由和视图函数

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

在Flask 程序中定义路由的最简便方式,是使用程序实例提供的app.route 修饰器,把修饰的函数注册为路由。下面的例子说明了如何使用这个修饰器声明路由

@app.route("/")
def index():
    return "<h1>hello,Flask</h1>"

前例把index() 函数注册为程序根地址的处理程序。如果部署程序的服务器域名为www.example.com,在浏览器中访问http://www.example.com 后,会触发服务器执行index() 函数。这个函数的返回值叫做响应,是客户端接收到的内容。像index这样的函数称为视图函数。视图函数的返回的响应可以是简单的html,也可以是复杂的表单。

如果你仔细观察日常所用服务的某些URL 格式,会发现很多地址中都包含可变部分,Flask 支持这种形式的URL,只需在route 修饰器中使用特殊的句法即可。下例定义的路由中就有一部分是动态名字

@app.route("/user/<name>")
def index(name):
    return "<h1>hello,%s</h1>" % name

路由中的动态部分默认使用字符串,不过也可使用类型定义。例如,路由/user/

启动服务器

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

if __name == ‘___main_‘:
    app.run(debug=True)

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

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

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

一个完整的程序

前几节介绍了Flask Web 程序的不同组成部分,现在是时候开发一个程序了。整个hello.py程序脚本就是把前面介绍的三部分合并到一个文件中。

from flask import Flask
app = Flask(__name__)

@app.route(‘/‘)
def index():
    return ‘<h1>hello,flask</h1>‘

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

之后激活虚拟环境,然后执行python hello.py,打印一下日志

 * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)
 * Restarting with stat
 * Debugger is active!
 * Debugger PIN: 240-501-696

在浏览器输入http://127.0.0.1:5000/,可以看到结果输出。

请求?响应循环

下面介绍一下flask框架的设计理念

程序和请求上下文

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 使用上下文让特定的变量在一个线程中全局可访问,与此同时却不会干扰其他线。

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

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

请求调度

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

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

>>> from hello import app
>>> app.url_map
Map([<Rule ‘/‘ (HEAD, OPTIONS, GET) -> index>,
 <Rule ‘/static/<filename>‘ (HEAD, OPTIONS, GET) -> static>])
>>> 

/ 路由在程序中使用app.route 修饰器定义。/static/

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

请求钩子

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

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

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

响应

Flask 调用视图函数后,会将其返回值作为响应的内容。大多数情况下,响应就是一个简单的字符串,作为HTML 页面回送客户端。但HTTP 协议需要的不仅是作为请求响应的字符串。HTTP 响应中一个很重要的部分是状态码,Flask 默认设为200,这个代码表明请求已经被成功处理。

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

@app.route(/)
def index():
    return ‘<p>bad request</p>‘,400

视图函数返回的响应还可接受第三个参数,这是一个由首部(header)组成的字典,可以添加到HTTP 响应中。如果不想返回由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

有一种名为重定向的特殊响应类型。这种响应没有页面文档,只告诉浏览器一个新地址用以加载新页面.重定向经常使用302 状态码表示,指向的地址由Location 首部提供。重定向响应可以使用3 个值形式的返回值生成,也可在Response 对象中设定。不过,由于使用频繁,Flask 提供了redirect() 辅助函数,用于生成这种响应:

from flask import redirect
@app.route(‘/‘)
def index():
    return redirect(‘http://www.example.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 服务器

以上是关于Flask从入门到精通之flask程序入门的主要内容,如果未能解决你的问题,请参考以下文章

Flask从入门到精通之自定义错误界面

Flask从入门到精通之链接的使用

Flask从入门到精通之大型程序的结构二

Flask框架从入门到精通之模板宏(十九)

Flask从入门到精通之大型程序的结构一

Flask框架从入门到精通之参数配置