Flask 基础笔记

路由

  • 要给 URL 添加变量部分,你可以把这些特殊的字段标记为 , 这个部分将会作为命名参数传递到你的函数。规则可以用 指定一个可选的转换器
关键字 解释
int 接受整数
float 同 int ,但是接受浮点数
path 和默认的相似,但也接受斜线
@app.route('/user/')
def show_user_profile(username):
    # show the user profile for that user
    return 'User %s' % username

@app.route('/post/')
def show_post(post_id):
    # show the post with the given id, the id is an integer
    return 'Post %d' % post_id
  • 唯一 URL / 重定向行为

待补充 / Werkzeug 文档

Flask 的 URL 规则基于 Werkzeug 的路由模块

@app.route('/projects/')
def projects():
    return 'The project page'

@app.route('/about')
def about():
    return 'The about page'
  • 构造 URL

以下例子就不用语言叙述了

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

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 方法
关键字 作用 常用
GET 浏览器告知服务器:只 获取 页面上的信息并发给我。这是最常用的方法
HEAD 浏览器告诉服务器:欲获取信息,但是只关心 消息头 。应用应像处理 GET 请求一样来处理它,但是不分发实际内容。在 Flask 中你完全无需 人工 干预,底层的 Werkzeug 库已经替你打点好了。
POST 浏览器告诉服务器:想在 URL 上 发布 新信息。并且,服务器必须确保 数据已存储且仅存储一次。这是 HTML 表单通常发送数据到服务器的方法。
PUT 类似 POST 但是服务器可能触发了存储过程多次,多次覆盖掉旧值。你可 能会问这有什么用,当然这是有原因的。考虑到传输中连接可能会丢失,在 这种 情况下浏览器和服务器之间的系统可能安全地第二次接收请求,而 不破坏其它东西。因为 POST 它只触发一次,所以用 POST 是不可能的。
DELETE 删除给定位置的信息。
OPTIONS 给客户端提供一个敏捷的途径来弄清这个 URL 支持哪些 HTTP 方法。 从 Flask 0.6 开始,实现了自动处理。
# 默认 method 为 get
from flask import request
@app.route('/login', methods=['GET', 'POST'])
def login():
    if request.method == 'POST':
        do_the_login()
    else:
        show_the_login_form()

静态文件(static)

也就是 web 里常用的 CSS/ JavaScript 文件, Flask默认配置路径为/static 可以通过 url_for('static', filename='style.css') 来获取静态文件的路径

模版渲染

Flask 使用 Jinja2 模板引擎, 默认模板路径为/templates Jinja2文档

from flask import render_template

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

请求数据

  • request
# 想使用该对象,需要从 flask 模块中导入
from flask import request

@app.route('/login', methods=['POST', 'GET'])
def login():
    error = None
    if request.method == 'POST':
    # 访问 form 属性中的不存在的键会发生什么?会抛出一个特殊的 `KeyError` 异常
        if valid_login(request.form['username'],
                       request.form['password']):
            return log_the_user_in(request.form['username'])
        else:
            error = 'Invalid username/password'
    return render_template('login.html', error=error)

# 获取 url 上的参数( GET )   类似于 `?key=value`
# 如果访问不存在的 key 也会抛出`KeyError`, 建议 catch
searchword = request.args.get('q', '')
  • upload file
from flask import request

@app.route('/upload', methods=['GET', 'POST'])
def upload_file():
    if request.method == 'POST':
        f = request.files['the_file']
        f.save('存在文件的路径')
    ...

# 你可以访问 filename 属性知道上传前文件在客户端的文件名
# 但请记住, 永远不要信任这个值,这个值是可以伪造的。如果你要把文件按客户端提供的 文件名存储在服务器上,那么请把它传递给 Werkzeug 提供的 secure_filename() 函数:

from flask import request
from werkzeug 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))
    ...
  • cookie

cookie 结构为 dict, 取不存在的 key 会产生 keyError 异常

from flask import request
from flask import make_response

@app.route('/')
def index():
    resp = make_response(render_template(...))
    # 存
    resp.set_cookie('username', 'the username')
    # 取
    username = request.cookies.get('username')
    return resp

重定向&错误

from flask import abort, redirect, url_for, render_template

@app.route('/')
def index():
    # 重定向到 login 函数
    return redirect(url_for('login'))

@app.route('/login')
def login():
    pass
    
@app.route('error')
def error():
    # 404
    abort(404)
    # this_is_never_executed
    
@app.errorhandler(404)
def page_not_found(error):
    return render_template('page_not_found.html'), 404

response

from flask import 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

session

暂无

logging

相关文档-> logging 文档

app.logger.debug('A value for debugging')
app.logger.warning('A warning occurred (%d apples)', 42)
app.logger.error('An error occurred')

你可能感兴趣的:(Flask 基础笔记)