Flask入门

作者: stoneyang94 | 来源:发表于2018-06-27 21:25 被阅读0次

Flask是一个Python编写的Web 微框架，让我们可以使用Python语言快速实现一个网站或Web服务。
本文参考自Flask官方文档，大部分代码引用自官方文档，对讲解细节有细微的调整，并且加入了自己实际运行的效果截图。
通过本文，读者可以对Flask有个基本的认识，并能够运用Flask做简单的网页。

初识Flask

安装Flask

使用pip

pip install flask

Pycharm可以在setting里导入

简单例子

输入下面的内容，并运行该.py文件
访问localhost:5000

应当可以看到浏览器上输出了Hello Flask!

from flask import Flask

app = Flask(__name__)  

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

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

分析流程

1. 导入`from flask import Flask`

导入了Flask类。
这个类的实例将会是我们的 WSGI（在 Web 应用和多种服务器之间的标准 Python 接口）应用程序。

2. 创建实例`app = Flask(name)`

创建一个该类的实例
第一个参数是应用模块或者包的名称。如果使用单一的模块（如本例），应该使用 __name__，因为模块的名称将会因其作为单独应用启动还是作为模块导入而有不同（也即是__main__ 或实际的导入名）。这是必须的，这样 Flask 才知道到哪去找模板、静态文件等

3. 配置装饰器`@app.route('url')`

用route() 装饰器告诉 Flask 什么样的URL 能触发我们的函数。

4. 函数`def func():`

函数的名字也在生成 URL 时被特定的函数采用
函数返回我们想要显示在用户浏览器中的信息

5. 运行应用`run()`

用run()函数让应用运行在本地服务器上
if __name__ =='__main__': 确保服务器只会在该脚本被 Python 解释器直接执行的时候才会运行，而不是作为模块导入的时候运行

用法扩展

一. 调试模式--debug = True

虽然run() 方法适用于启动本地的开发服务器，但是每次修改代码后都要手动重启它
如果启用了调试支持，服务器会在代码修改后自动重新载入，并在发生错误时提供一个相当有用的调试器

有两种途径来启用调试模式。一种是直接在应用对象上设置:

app.debug = True
app.run()

另一种是作为 run 方法的一个参数传入:

app.run(debug=True)

两种方法的效果完全相同。

二. 路由--@app.route('url')

route()装饰器把一个函数绑定到对应的 URL 上

语法
使用Flask的app.route("url")装饰器来设置，类似Java的注解。

@app.route('/')
def index():
    return 'Index Page'

@app.route('/hello')
def hello():
    return 'Hello, World'

三. 路径变量--@app.route('/path/<converter:varname>')

要给 URL 添加变量部分，你可以把这些特殊的字段标记为 <varname> ，这个部分将会作为命名参数传递到你的函数
在路径变量前还可以使用可选的转换器，有以下几种转换器：

转换器	作用
string	默认选项，接受除了斜杠之外的字符串
int	接受整数
float	接受浮点数
path	和string类似，不过可以接受带斜杠的字符串
any	匹配任何一种转换器
uuid	接受UUID字符串

例子：

@app.route('/user/<username>')
def show_user_profile(username):
    # show the user profile for that user
    return 'User %s' % username

@app.route('/post/<int:post_id>')
def show_post(post_id):
    # show the post with the given id, the id is an integer
    return 'Post %d' % post_id

四. 构造URL---url_for('methodName')

定义
使用Flask生成URL
用途
获取某个页面的URL

例子：

from flask import Flask, url_for
 app = Flask(__name__)
@app.route('/')
    def index(): pass

@app.route('/login')
    def login(): pass

@app.route('/user/<username>')
    def profile(username): pass

with app.test_request_context():
    print url_for('index')
    print url_for('login')
    print url_for('login', next='/')
    print url_for('profile', username='John Doe')

输出：
/
/login
/login?next=/
/user/John%20Doe

五. HTTP方法--@app.route('url', methods=['GET', 'POST'])

默认情况下，路由只回应 GET 请求
通过route()装饰器传递methods参数可以改变这个行为

@app.route('/login', methods=['GET', 'POST'])
def login():
    if request.method == 'POST':
        do_the_login()
    else:
        show_the_login_form()

HTTP 方法

作用
浏览器告知服务器，客户端想对请求的页面做些什么。

方法	作用
GET	只获取页面上的信息并发给我。这是最常用的方法
HEAD	欲获取信息，但是只关心消息头。应用应像处理GET请求一样来处理它，但是不分发实际内容
POST	想在URL上发布新信息。服务器必须确保数据已存储且仅存储一次。这是HTML表单通常发送数据到服务器的方法
PUT	类似 POST 但是服务器可能触发了存储过程多次，多次覆盖掉旧值
DELETE	删除给定位置的信息
OPTIONS	给客户端提供一个敏捷的途径来弄清这个 URL 支持哪些 HTTP 方法。从 Flask 0.6 开始，实现了自动处理

六. 静态文件--url_for('static', filename=' ')

Web程序中常常需要处理静态文件，在Flask中需要使用url_for函数并指定static端点名和文件名。在下面的例子中，实际的文件应放在static/文件夹下。

给静态文件生成 URL ，使用特殊的 'static' 端点名:

url_for('static', filename='style.css')

这个文件应该存储在文件系统上的 static/style.css 。

七. 模板渲染--render_template('tempName', arg)

模板位置
Flask默认使用Jinja2作为模板，Flask会自动配置Jinja 模板，所以我们不需要其他配置了。默认情况下，模板文件需要放在templates文件夹下。
语法
使用 Jinja 模板，只需要用render_template函数并传入模板文件名和参数名即可

from flask import render_template

@app.route('/hello/')
@app.route('/hello/<name>')
def hello(name=None):
    return render_template('hello.html', name=name)

相应的模板文件如下:

<!doctype html>
<title>Hello from Flask</title>
{% if name %}
  <h1>Hello {{ name }}!</h1>
{% else %}
  <h1>Hello, World!</h1>
{% endif %}

处理请求

在 Flask 中获取请求参数需要使用request等几个全局对象，但是这几个全局对象比较特殊，它们是 Context Locals ，其实就是 Web 上下文中局部变量的代理。
虽然我们在程序中使用的是全局变量，但是对于每个请求作用域，它们都是互不相同的变量。

一. Request 对象--request.method or form

作用

Request 对象是一个全局对象，利用它的属性和方法，我们可以方便的获取从页面传递过来的参数。

两个属性

method属性会返回HTTP方法
form属性是一个字典，如果数据是POST类型的表单，就可以从form属性中获取

例子

导入模块：

from flask import request

调用：

@app.route('/login', methods=['POST', 'GET'])
def login():
    error = None
    if request.method == 'POST':
        if valid_login(request.form['username'],
                       request.form['password']):
            return log_the_user_in(request.form['username'])
        else:
            error = 'Invalid username/password'
    # the code below is executed if the request method was GET 
    # or the credentials were invalid
    return render_template('login.html', error=error)

二. 文件上传--request.files

获取文件
request 的files属性是一个字典，包含了被上传的文件。利用 request 的files属性，可以获取表单中上传的文件
获取文件名
可以使用filename属性，不过这个属性可以被客户端更改，所以并不可靠。更好的办法是利用werkzeug提供的secure_filename方法来获取安全的文件名。

from flask import request
from werkzeug.utils import secure_filename

@app.route('/upload', methods=['GET', 'POST'])
def upload_file():
    if request.method == 'POST':
        f = request.files['the_file']
        f.save('/var/www/uploads/' + secure_filename(f.filename))

三. Cookies--request.cookies

请求对象的cookies 属性是一个内容为客户端提交的所有 Cookies 的字典

语法
读取：request.cookies.get('username')
存储：set_cookie('username', 'the username')

例子：

from flask import request
#读取
@app.route('/')
def index():
    username = request.cookies.get('username')
    # 使用 cookies.get(key) 代替 cookies[key] 得到 KeyError
    # 避免cookie不存在

from flask import make_response
# 存储
@app.route('/')
def index():
    resp = make_response(render_template(...))
    resp.set_cookie('username', 'the username')
    return resp

四. 重定向和错误

语法

redirect()和abort()函数用于重定向和返回错误页面。

from flask import abort, redirect, url_for

@app.route('/')
def index():
    return redirect(url_for('login'))

@app.route('/login')
def login():
    abort(401)
    this_is_never_executed()

自定义错误--@app.errorhandler(404)

默认情况下，错误代码会显示一个黑白的错误页面
如果需要自定义错误页面，可以使用errorhandler装饰器

from flask import render_template

@app.errorhandler(404)
def page_not_found(error):
    return render_template('page_not_found.html'), 404

注意render_template()调用之后的 404 ，表示该页的错误代码是 404 。

五. 响应处理

默认方式

默认情况下，Flask会根据函数的返回值自动决定如何处理响应：

如果返回的是一个合法的响应对象，它会从视图直接返回
如果返回的是一个字符串，被转换为该字符串为主体的、状态码为200 OK的、 MIME 类型是text/html的响应对象
如果返回的是一个元组，且元组中的元素可以提供额外的信息。这样的元组必须是 (response, status, headers) 的形式，且至少包含一个元素。 status 值会覆盖状态代码， headers 可以是一个列表或字典，作为额外的消息标头值。
如果上述条件均不满足， Flask 会假设返回值是一个合法的 WSGI 应用程序，并转换为一个请求对象。

自定义--make_response

我们也可以自己决定如何设置响应对象，方法也很简单，使用make_response函数即可。

@app.errorhandler(404)
def not_found(error):
    resp = make_response(render_template('error.html'), 404)
    resp.headers['X-Something'] = 'A value'
    return resp

六. Sessions

作用
session允许你在不同请求间存储特定用户的信息。
指定密钥
我们可以使用全局对象session来管理用户会话。Sesison 是建立在 Cookie 技术上的，不过在 Flask 中，我们还可以为 Session 指定密钥，这样存储在 Cookie 中的信息就会被加密，从而更加安全。

例子：

from flask import Flask, session, redirect, url_for, escape, request

app = Flask(__name__)

@app.route('/')
def index():
    if 'username' in session:
        return 'Logged in as %s' % escape(session['username'])
    return 'You are not logged in'

@app.route('/login', methods=['GET', 'POST'])
def login():
    if request.method == 'POST':
        session['username'] = request.form['username']
        return redirect(url_for('index'))
    return '''
        <form method="post">
            <p><input type=text name=username>
            <p><input type=submit value=Login>
        </form>
    '''

@app.route('/logout')
def logout():
    # remove the username from the session if it's there
    session.pop('username', None)
    return redirect(url_for('index'))

# set the secret key.  keep this really secret:
app.secret_key = 'A0Zr98j/3yX R~XHH!jmN]LWX/,?RT'

参考文章
Flask官方文档手册
 Flask入门系列
 Flask 快速入门

Flask入门

初识Flask

安装Flask

简单例子

分析流程

1. 导入`from flask import Flask`

2. 创建实例`app = Flask(name)`

3. 配置装饰器`@app.route('url')`

4. 函数`def func():`

5. 运行应用`run()`

用法扩展

一. 调试模式--debug = True

二. 路由--@app.route('url')

三. 路径变量--@app.route('/path/<converter:varname>')

四. 构造URL---url_for('methodName')

五. HTTP方法--@app.route('url', methods=['GET', 'POST'])

HTTP 方法

六. 静态文件--url_for('static', filename=' ')

七. 模板渲染--render_template('tempName', arg)

处理请求

一. Request 对象--request.method or form

作用

两个属性

例子

二. 文件上传--request.files

三. Cookies--request.cookies

四. 重定向和错误

语法

自定义错误--@app.errorhandler(404)

五. 响应处理

默认方式

自定义--make_response

六. Sessions

相关文章

网友评论

延伸阅读

深度阅读

栏目导航

热点阅读

我爱编程

Flask入门

初识Flask

安装Flask

简单例子

分析流程

1. 导入from flask import Flask

2. 创建实例app = Flask(__name__)

3. 配置装饰器@app.route('url')

4. 函数def func():

5. 运行应用run()

用法扩展

一. 调试模式--debug = True

二. 路由--@app.route('url')

三. 路径变量--@app.route('/path/<converter:varname>')

四. 构造URL---url_for('methodName')

五. HTTP方法--@app.route('url', methods=['GET', 'POST'])

HTTP 方法

六. 静态文件--url_for('static', filename=' ')

七. 模板渲染--render_template('tempName', arg)

处理请求

一. Request 对象--request.method or form

作用

两个属性

例子

二. 文件上传--request.files

三. Cookies--request.cookies

四. 重定向和错误

语法

自定义错误--@app.errorhandler(404)

五. 响应处理

默认方式

自定义--make_response

六. Sessions

相关文章

网友评论

延伸阅读

深度阅读

栏目导航

热点阅读

我爱编程

1. 导入`from flask import Flask`

2. 创建实例`app = Flask(name)`

3. 配置装饰器`@app.route('url')`

4. 函数`def func():`

5. 运行应用`run()`