一起学FLask -第一章，基础入门

本来想学习使用mock，发现API server一般使用的flask框架。。简单学习一下flask框架。

推荐一个版本的pycharm 下载地址：https://pan.baidu.com/s/13qD_sMZiEttyjphad-zqmQ

我觉得这个版本的pycharm 对python web框架还是比较友好的。

下面这个链接，是本人写的django 的入门。。

https://blog.csdn.net/qq_39208536/article/details/81540605

flask 的安装pip install flask 。

pycham 可以创建flask项目，（个人感觉通过pycharm来创建web项目还凑合，不是很好用）

1.程序的基本结构

1.初始化

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

from flask import Flask

app = Flask(__name__)

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

1.2　路由和视图函数

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

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

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

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

前例把 index() 函数注册为程序根地址的处理程序。如果部署程序的服务器域名为 www. example.com，在浏览器中访问 http://www.example.com 后，会触发服务器执行 index() 函数。这个函数的返回值称为响应，是客户端接收到的内容。如果客户端是 Web 浏览器，响应就是显示给用户查看的文档。像 index() 这样的函数称为视图函数（view function）。视图函数返回的响应可以是包含 HTML 的简单字符串，也可以是复杂的表单。

如果你仔细观察日常所用服务的某些 URL 格式，会发现很多地址中都包含可变部分。例如，你的 Facebook 资料页面的地址是

http://www.facebook.com/<your-name>

用户名（your-name）是地址的一部分。Flask 支持这种形式的 URL，只需在 route 修饰器中使用特殊的句法即可。下例定义的路由中就有一部分是动态名字：

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

尖括号中的内容就是动态部分，任何能匹配静态部分的 URL 都会映射到这个路由上。调用视图函数时，Flask 会将动态部分作为参数传入函数。在这个视图函数中，参数用于生成针对个人的欢迎消息。

路由中的动态部分默认使用字符串，不过也可使用类型定义。例如，路由 /user/ 只会匹配动态片段 id 为整数的 URL。Flask 支持在路由中使用 int、float 和 path 类型。 path 类型也是字符串，但不把斜线视作分隔符，而将其当作动态片段的一部分。

1.3　启动服务器

程序实例用 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 服务器不适合在生产环境中使用。

1.4　一个完整的程序

一个完整的 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)

点击运行该程序（点击run 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://localhost:5000/user/Dave。程序会显示一个使用 name 动态参数生成的欢迎消息。请尝试使用不同的名字，可以看到视图函数总是使用指定的名字生成响应。

1.5　请求-响应循环

介绍flask框架的一些设计理念

1.5.1　程序和请求上下文

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

from flask import request
from flask import Flask
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)

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

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

1.5.2　请求调度

程序收到客户端发来的请求时，要找到处理该请求的视图函数。为了完成这个任务，Flask 会在程序的 URL 映射中查找请求的 URL。URL 映射是 URL 和视图函数之间的对应关系。

Flask 使用 app.route 修饰器或者非修饰器形式的 app.add_url_rule() 生成映射。

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

2.5.3　请求钩子

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

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

• before_request：注册一个函数，在每次请求之前运行。

• after_request：注册一个函数，如果没有未处理的异常抛出，在每次请求之后运行。

• teardown_request：注册一个函数，即使有未处理的异常抛出，也在每次请求之后运行。

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

1.5.4　响应

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


from flask import Flask
app = Flask(__name__)

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

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

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

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

from flask import make_response
from flask import Flask
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)

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

重定向经常使用 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 服务器。

2.5 Flask扩展

Flask 被设计为可扩展形式，故而没有提供一些重要的功能，例如数据库和用户认证，所以开发者可以自由选择最适合程序的包，或者按需求自行开发。社区成员开发了大量不同用途的扩展，如果这还不能满足需求，你还可使用所有 Python 标准包或代码库。为了让你知道如何把扩展整合到程序中，接下来我们将在 hello.py 中添加一个扩展，使用命令行参数增强程序的功能。

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

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

Flask-Script 扩展使用 pip 安装：

(venv) $ pip install flask-script

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

示例 1-1 hello.py：使用 Flask-Script

from flask import Flask
from flask_script import Manager

app = Flask(__name__)
manager = Manager(app)




@app.route('/')
def hello_world():
    return 'Hello World!'


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

专为 Flask 开发的扩展都暴漏在 flask_script 命名空间下。flask_script 输出了一个名为 Manager 的类，可从 flask_script 中引入。

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

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

D:\python3\python.exe C:/Users/Administrator/PycharmProjects/Flask/Hello.py
usage: Hello.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

Process finished with exit code 2

一起学FLask -第一章，基础入门

猜你喜欢