0
0

Flask入门学习教程

Flask学习

文章目录

代码仓库：https://github.com/LenkyAndrews/Flask-Learning

1.简介

Flask是目前十分流行的web框架，采用Python编程语言来实现相关功能。它被称为微框架(microframework)，“微”是指Flask旨在保持代码简洁且易于扩展，Flask框架的主要特征是核心构成比较简单，但具有很强的扩展性和兼容性。

Flask主要包括

Werkzeug

和

Jinja2

两个核心函数库，它们分别负责业务处理和安全方面的功能，这些基础函数为web项目开发过程提供了丰富的基础组件。

2.安装

使用以下指令安装：

pip install flask

输入指令查看版本

import flask
print(flask.__version__)# 2.0.1

3.最小的应用

# 导入Flask类库from flask import Flask
# 创建应用实例
app = Flask(__name__)# 视图函数（路由）@app.route("/")defhello_world():return"Hello, World!"# 启动服务if __name__ =='__main__':
   app.run(debug =True)
  1. 首先导入了 Flask类。
  2. 接着创建一个该类的实例。第一个参数是应用模块或者包的名称。 __name__ 是一个适用于大多数情况的快捷方式。
  3. 然后使用 route()装饰器来告诉 Flask 触发函数 的 URL 。app.route(rule, options)rule 参数表示与该函数的URL绑定options 是要转发给基础Rule对象的参数列表。
  4. 函数返回需要在浏览器中显示的信息。

保存为

app.py

，一般不要使用 

flask.py

作为应用名称，这会与 Flask 本身发生冲突。服务启动默认使用5000端口，在浏览器中打开 http://127.0.0.1:5000/ ，可以看到 Hello World! 字样。

app.run(host, port, debug, options)

参数说明默认值host主机名，设置为“0.0.0.0”以使服务器在外部可用127.0.0.1（localhost）port端口号5000debug调试模式，代码更新会自动重启服务，提供一个调试器来跟踪应用程序中的错误Falseoptions要转发到底层的Werkzeug服务器的参数

4.路由

现代Web框架使用路由技术来帮助用户记住应用程序URL。Flask中的

route()

装饰器用于将URL绑定到函数，例如：

@app.route('/hello')defhello_world():return'hello world'

URL 

/hello

规则绑定到hello_world()函数，如果访问http://localhost:5000/hello，hello_world()函数的输出将在浏览器中呈现。

5.变量规则

通过把 URL 的一部分标记为 

<variable_name>

就可以在 URL 中添加变量，标记的部分会作为关键字参数传递给函数。

from flask import Flask
app = Flask(__name__)@app.route('/hello/<username>')defhello(username):returnf'Hello {username}!'if __name__ =='__main__':
   app.run(debug =True)

在上面的例子中，在浏览器中输入http://localhost:5000/hello/Kint，则

Kint

将作为参数提供给 hello()函数，即username的值为

Kint

。在浏览器中的输出如下

Hello Kint!

通过使用 

<converter:variable_name>

，可以选择性的加上一个转换器，为变量指定规则。
转换器说明

string

（缺省值） 接受任何不包含斜杠的文本

int

接受正整数

float

接受正浮点数

path

类似 

string

，但可以包含斜杠
完整示例：

from flask import Flask
from markupsafe import escape

app = Flask(__name__)@app.route('/hello/<username>')defhello(username):returnf'Hello {username}!'@app.route('/post/<int:post_id>')defshow_post(post_id):returnf'Post {post_id}'@app.route('/path/<path:path>')defshow_path(path):returnf'path {escape(path)}'if __name__ =='__main__':
    app.run(debug=True)

在浏览器中输入http://localhost:5000/integer/56，输出如下

Integer:56

在浏览器中输入http://localhost:5000/path/templates/index.html，输出如下

path: templates/index.html

6.URL构建

url_for()

函数用于构建指定函数的 URL。它把函数名称作为第一个参数。它可以接受任意个关键字参数，每个关键字参数对应 URL 中的变量，未知变量 将添加到 URL 中作为查询参数。

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

app = Flask(__name__)@app.route('/')defindex():return'index'@app.route('/login')deflogin():print(f"in login function, request.values: {request.values}")return'login'@app.route('/user/<username>')defprofile(username):returnf'{username}\'s profile'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'))

url_for('login', next='/')

会生成对应的URL，但

next

并不是login函数的关键字参数，故作为查询参数，与GET请求发送的数据类似，可以在request.values中查询到

CombinedMultiDict([ImmutableMultiDict([('next', '/')])])

输出如下：

//login
/login?next=%2F/user/John%20Doe

7.HTTP方法

Web 应用使用不同的 HTTP 方法处理 URL ，HTTP方法如下（加粗的方法较为常见）：
方法说明GET以未加密的形式将数据发送到服务器，最常见的方法HEAD和GET方法相同，但没有响应体POST用于将HTML表单数据发送到服务器，POST方法接收的数据不由服务器缓存PUT用上传的内容替换目标资源的所有当前表示DELETE删除由URL给出的目标资源的所有当前表示
默认情况下，Flask路由只回应 

GET

请求。可以使用 

route()

装饰器的 

methods

参数来处理不同的 HTTP 方法。

将以下脚本另存为welcome.html，放在templates文件夹中。

<!DOCTYPEhtml><htmllang="en"><head><metacharset="UTF-8"><title>HTTP方法</title></head><body><formaction="http://localhost:5000/login"method="post"><p>Enter Name:</p><p><inputtype="text"name="username"/></p><p><inputtype="submit"value="submit"/></p></form></body></html>

flask代码如下：

from flask import Flask, redirect, url_for, request, render_template
app = Flask(__name__)@app.route('/')defindex():return render_template('welcome.html')@app.route('/welcome/<name>')defwelcome(name):returnf'welcome {name}'@app.route('/login', methods=['POST','GET'])deflogin():if request.method =='POST':
        user = request.form['username']return redirect(url_for('welcome', name=user))else:
        user = request.args.get('username')# GET方法获取数据，args是包含表单参数对及其对应值对的列表的字典对象。return redirect(url_for('welcome', name=user))if __name__ =='__main__':
    app.run(debug=True)

如果请求方式是POST方法，则通过以下代码获得从表单数据获得的“username”参数的值：

user = request.form['username']

如果请求方式是GET方法，则通过以下代码获得从表单数据获得的“username”参数的值：

user = request.args.get('username')

args

是包含表单参数对及其对应值对的列表的字典对象，与’username’参数对应的值将传递到

/welcome

URL中，即

/login?username=Kint

8.文件存放

flask项目中，

static

文件夹中存放CSS 和 JavaScript文件，

templates

文件夹中存放html文件。app.py与templates和static文件夹同级目录。

/app.py
/templates
    /index.html
/static/style.css
    /jquery.js

果然想要更改路径可以在初始化Flask实例时进行修改

app = Flask(__name__, static_folder='', template_folder='')

9.渲染模板

使用 

render_template()

方法可以渲染模板，提供模板名称和需要作为参数传递给模板的变量。

在templates文件夹下创建render_template.html文件，代码如下：

<!DOCTYPEhtml><htmllang="en"><head><metacharset="UTF-8"><title>render_template</title></head><body><h2>渲染模板</h2>
    {{ my_int }}
    <br>
    {{ my_str }}
    <br>
    {{ my_list }}
    <br>
    {{ my_dict }}
    <hr><h2>列表数据获取</h2>
    {{ my_list[0] }}
    <br>
    {{ my_list.1 }}
    <hr><h2>字典数据获取</h2>
    {{ my_dict['name'] }}
    <br>
    {{ my_dict.age }}
    <hr><h2>算术运算</h2>
    {{ my_list.0 + 10 }}
    <br>
    {{ my_list[0] + my_list.1 }}
</body></html>

flask代码如下：

from flask import Flask, render_template

app = Flask(__name__)@app.route('/')defindex():
    int_ =1024
    str_ ='Hello World!'
    list_ =[1,2,3,4,5]
    dict_ ={'name':'Kint','age':23}# render_template方法:渲染模板# 参数1: 模板名称  参数n: 传到模板里的数据return render_template('render_template.html', my_int=int_, my_str=str_, my_list=list_, my_dict=dict_)if __name__ =='__main__':
    app.run(debug=True)

效果如下：

在这里插入图片描述

Flask 是使用 Jinja2 这个模板引擎来渲染模板，更多内容，详见官方 Jinja2 模板文档。

10.Request对象

部分属性如下（加粗的较为常见）：
属性说明method请求方法，比如GET、POSTdata以字符串的形式存储请求的数据files上传的文件，类型为MultiDictargs解析URL中提交的参数，类型为MultiDictform上传的表单数据，类型为MultiDictvalues包含args和form的数据，类型为CombineMultiDictjson解析JSON数据，如果没有则返回Nonecookies包含客户端传输的所有 cookies ，类型为MultiDictheaders请求头信息，类似字典，可通过关键词获取对应得信息
在templates文件夹下创建Request.html文件，代码如下：

<!DOCTYPEhtml><htmllang="en"><head><metacharset="UTF-8"><title>Request</title></head><body><formaction="/login?a=1&b=2"method="post"><p>账号: <inputtype="text"name="username"></p><p>密码: <inputtype="password"name="password"></p><inputtype="submit"></form></body></html>

flask代码如下：

from flask import Flask, request, render_template
import json

app = Flask(__name__)@app.route('/')defindex():return render_template("Request.html")@app.route('/login', methods=["GET","POST"])deflogin():print('request.method:\n', request.method)print('request.data:\n', request.data)print('request.request.args:\n', request.args)print("request.request.args.get('b'):\n", request.args.get('c'))print('request.form:\n', request.form)print("request.request.form.get('password'):\n", request.form.get('password'))print('request.values:\n', request.values)print('request.json:\n', request.json)print('request.cookies:\n', request.cookies)print('request.headers:\n', request.headers)return json.dumps(request.form)# 将MultiDict数据处理为JSON数据if __name__ =='__main__':
    app.run(debug=True)

效果如下：

后端输出如下：

在这里插入图片描述

在这里插入图片描述

以request.form为例，在获取MultiDict的值时，推荐使用

request.form.get(key)

而不直接使用

request.form[key]

，前一种方式可以避免关键词缺失而导致的KeyError。

获取各种路径，本例中的URL为

http://127.0.0.1:5000/login?a=1&b=2

print('url: ', request.url)print('base_url: ', request.base_url)print('host: ', request.host)print('host_url: ', request.host_url)print('path: ', request.path)print('full_path: ', request.full_path)

输出为：

url:  http://127.0.0.1:5000/login?a=1&b=2
base_url:  http://127.0.0.1:5000/login
host:127.0.0.1:5000
host_url:  http://127.0.0.1:5000/
path:/login
full_path:/login?a=1&b=2

11.Cookie

Cookie以文本文件的形式存储在客户端的计算机上。其目的是记住和跟踪与客户使用相关的数据，以获得更好的访问者体验和网站统计信息。比如网站为了辨别用户身份、进行会话跟踪需要把一些数据 (例如：登录状态、用户名称) 储存在用户本地终端上，这些数据被称为 Cookie。

Request对象包含Cookie的属性，它是所有Cookie变量及其对应值的字典对象。

在Flask中，对Cookie的处理步骤为：

  1. 使用Response对象的set_cookie()方法设置cookie
  2. 通过request.cookies的方式获取cookies，返回的是一个字典
  3. 使用Response对象的delete_cookie()方法设置cookie

在templates文件夹下创建get_cookie.html文件，代码如下：

<!DOCTYPEhtml><htmllang="en"><head><metacharset="UTF-8"><title>获取cookie</title></head><body><h2>在服务端获取cookie: <b>{{cookie}}</b></h2></body></html>

在templates文件夹下创建show_cookie_by_JQuery.html文件，代码如下：

<!DOCTYPEhtml><htmllang="en"><head><metacharset="UTF-8"><title>设置cookie</title><scriptsrc="../static/jquery-3.6.0.js"type="text/javascript"charset="utf-8"></script></head><body><h2>在服务端设置cookie</h2><h2>在客户端通过JQuery读取cookie: <bid='cookie'></b></h2></body><script>$('#cookie').text(document.cookie);</script></html>

flask代码如下：

from flask import Flask, request, Response, render_template, make_response, redirect, url_for

app = Flask(__name__)@app.route('/')defindex():return redirect(url_for('set_cookie'))# 重定向响应的URL# 获取[email protected]('/get_cookie')defget_cookie():
    cookie = request.cookies.get('user')# 获取关键字为user对应cookie的值print(cookie)return render_template('get_cookie.html', cookie=cookie)# 设置[email protected]('/set_cookie')defset_cookie():
    html = render_template('show_cookie_by_JQuery.html')
    response = make_response(html)# 设置响应体# response = Response(html)
    response.set_cookie('user','Kint')return response

# 删除[email protected]('/del_cookie')defdel_cookie():
    html = render_template('show_cookie_by_JQuery.html')
    response = Response(html)
    response.delete_cookie('user')return response

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

在set_cookie()函数中，首先渲染模板文件show_cookie_by_JQuery.html，通过make_response()方法设置响应体并返回Response对象，然后设置cookie。以下两种写法作用相同：

response = make_response(html)# 设置响应体
response = Response(html)

在浏览器中输入http://127.0.0.1:5000/set_cookie，可以看到在响应头信息中已经设置好cookie的数据了。

在这里插入图片描述

在浏览器中输入http://127.0.0.1:5000/get_cookie，可以看到请求头信息中cookie的数据，并且将cookie传输到服务端上。

在这里插入图片描述

在浏览器中输入http://127.0.0.1:5000/del_cookie，此时响应体信息中已经没有

user

对应的cookie值了。

在这里插入图片描述

12.会话Session

与Cookie不同，Session数据存储在服务器上，用来存储用户的信息 (例如登录状态、用户名称)。Session 有一个唯一标识 ID，对应一个用户，在服务端使用 ID 可以查找到对应用户的数据，故Flask应用程序需要一个定义的密钥SECRET_KEY。

以下代码简单实现判断用户是否登录功能：

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

app = Flask(__name__)
app.secret_key ='abc'@app.route('/')defindex():if'user'in session:# 获取会话中的用户信息
        user = session.get('user')return'登录用户是:'+ user +'<br>'+"<b><a href = '/logout'>点击这里注销</a></b>"return"<h3>暂未登录</h3><br>"+"<a href = '/login'></b>点击这里登录</b></a>"@app.route('/login', methods=['GET','POST'])deflogin():if request.method =='POST':# 设置会话中的用户信息
        session['user']= request.form['user']return redirect(url_for('index'))return'''
    <form action="" method="post">
        <p><input type="text" name="user"/></p>
        <p><input type="submit" value="登录"/></p>
    </form>
    '''@app.route('/logout')deflogout():# 删除会话中的用户信息
    session.pop('user')return redirect(url_for('index'))if __name__ =='__main__':
    app.run(debug=True)

效果如下：

实例1.上传表单数据

文件结构如下：

/app.py
/templates
    /login.html
    /result.html

app.py代码如下：

from flask import Flask, render_template, request
app = Flask(__name__)@app.route('/')defstudent():return render_template('login.html')@app.route('/result',methods =['POST','GET'])defresult():if request.method =='POST':
      result = request.form #拿到前端传输的表单数据return render_template("result.html",result = result)if __name__ =='__main__':
   app.run(debug =True)

在templates文件夹下创建login.html文件，代码如下：

<!DOCTYPEhtml><htmllang="en"><head><metacharset="UTF-8"><title>实例1.上传表单数据—登录页面</title></head><body><formaction="http://localhost:5000/result"method="POST"><p>Name <inputtype="text"name="Name"/></p><p>Email <inputtype="text"name="Email"/></p><p><inputtype="submit"value="submit"/></p></form></body></html>

在templates文件夹下创建result.html文件，代码如下：

<!DOCTYPEhtml><htmllang="en"><head><metacharset="UTF-8"><title>实例1.上传表单数据-结果页面</title></head><body><tableborder= 1>
        {% for key, value in result.items() %}
        <tr><th> {{ key }} </th><td> {{ value }}</td></tr>
        {% endfor %}
    </table></body></html>

实例2.上传下载文件

文件结构如下：

/app.py
/templates
    /index.html
    /upload.html
/upload
    /download_sample.txt

app.py代码如下：

from flask import Flask, render_template, request, send_from_directory
from werkzeug.utils import secure_filename

import os

app = Flask(__name__)
app.config['UPLOAD_FOLDER']='upload/'
app.config['MAX_CONTENT_LENGTH']=16*1000*1000# 上传文件大小限制为16M，如果超过会抛出异常@app.route('/')defupload_file():return render_template('index.html')@app.route('/upload', methods=['GET','POST'])defupload():if request.method =='POST':
        f = request.files['file']print(request.files)# secure_filename检查客户端上传的文件名，确保安全，注意文件名称不要全中文！！！
        f.save(os.path.join(app.config['UPLOAD_FOLDER'], secure_filename(f.filename)))return render_template('upload.html')else:return render_template('index.html')@app.route('/download/<filename>', methods=['GET','POST'])defdownload(filename):# as_attachment=True 表示文件作为附件下载return send_from_directory('./upload', filename, as_attachment=True)if __name__ =='__main__':
    app.run(debug=True)

在

upload

函数中，

f.save

的作用是将文件保存到指定路径中。在使用

secure_filename

检验上传文件名称时，注意名称尽量为英文！

在

download

函数中，

send_from_directory

方法将upload目录下的指定文件发送到客户端，

as_attachment=True

表示文件作为附件下载。

在templates文件夹下创建index.html文件，代码如下：

<!DOCTYPEhtml><htmllang="en"><head><metacharset="UTF-8"><title>实例2.上传下载文件</title></head><body><h3>上传文件</h3><formaction="http://localhost:5000/upload"method="POST"enctype="multipart/form-data"><inputtype="file"name="file"/><inputtype="submit"value="提交"/></form><h3>下载文件</h3><ahref="/download/download_sample.txt">download_sample.txt</a></body></html>

在templates文件夹下创建upload.html文件，代码如下：

<!DOCTYPEhtml><htmllang="en"><head><metacharset="UTF-8"><title>实例2.文件上传成功页面</title></head><body><h3>文件上传成功！</h3></body></html>
标签： flask python 后端
本文转载自: https://blog.csdn.net/weixin_46003347/article/details/122938176
版权归原作者 暄踽 所有， 如有侵权，请联系我们删除。
登录后发布评论

“Flask入门学习教程”的评论:

还没有评论
关于作者
...
overfit同步小助手
文章同步
相关阅读

CertiK安全调研报告：Web3.0桌面钱包的初步安全评估

CentOS 7 系统中安装与配置 Telnet 服务详解（使用非root用户登录）

【Java知识】Java性能测试工具JMeter

Scenarigo：端到端的HTTP/gRPC场景测试工具

IDEA中通义灵码的使用技巧

迷你版VFB，极简的Freebasic开发IDE-VB7-vb6编程开发

Git的安装与使用

文章导航