Flask是一个相对于Django而言轻量级的Web框架。
和Django大包大揽不同,Flask建立于一系列的开源软件包之上,这其中 最主要的是WSGI应用开发库Werkzeug和模板引擎Jinja:
策略 :werkzeug和Jinja这两个库和Flask一样,都是pocoo团队开发的。这 或许体现了pocoo与Django竞争时关于生态的一种策略,这种策略的自然延伸是Flask框架中没有包含数据库方面的构件,无论ORM还是其他。
关注点 :Flask是一个WSGI应用框架,这意味着我们进行Flask开发时,不需要 关注网络方面的操作,Flask应用的入口是封装过的网络请求包,出口是 网络响应,我们仅需要关注这个阶段内的处理逻辑。
WSGI服务器 :Flask虽然内置了简单的WSGI服务器,但其性能仅仅适用于开发期的调试。 Flask官网推荐了多种WSGI服务器,实现方式从多进程到多线程到协程, 这方面的选择我们在本课程中将不涉及。
REST适应性 :虽然Flask和Django一样,最初的出发点都是服务端的动态网页应用。但 Flask的设计使之也相当适用于面向资源的REST架构,在越来越移动化 并且单页应用越来越重要的WEB开发领域,这是Flask相对于Django相当 大的优势。
这里推荐大家一个学习flask的教程,本文的内容也是转自该教程。
Hello Flask
编写一个基于Flask的hello world相当容易:
1、导入Flask类
from flask import Flask
Flask类是Flask框架的核心类,它实现了WSGI应用规范。
2、创建Flask实例
app = Flask(__name__)
Flask构造函数的第一个参数指定一个引入名/importname。Flask框架 使用这个名字进行静态资源、模板、错误信息的定位。除非你清楚的理解它的 作用,通常情况下,我们总应该使用特殊变量_name。
Flask实例是可调用的(具有call方法),这个实例可以直接对接 WSGI服务器。
3、注册路由
@route('/')
def index():
return 'Hello,Flask!'
注册路由就是建立URL规则和处理函数之间的关联。Flask框架依赖于路由 完成HTTP请求的分发。
路由中的函数被称为视图函数,其返回值将作为HTTP响应的正文内容。
4、对接并启动WSGI服务器
Flask封装了一个简单的开发用WSGI服务器,我们可以通过调用run() 启动服务器运行:
app.run(host='0.0.0.0',port=80)
路由是MVC架构的Web框架中相当重要的一个概念,也是本节课程的重点。
顾名思意,路由就是在迷茫中找出一条路的意思。在Flask框架中的路由就表示为用户请求的URL找出其对应的处理函数之意。
在本节课程,我们将主要从以下几个方面讲解Flask框架中的路由:
如何为应用注册路由? 如何为路由指定其支持的HTTP方法? 如何匹配动态URL? 如何对URL中的变量类型进行过滤? 如何理解访问点/endpoint? 如何为应用设定静态路由? 如何避免硬编码指向其他视图的URL?
在Flask应用中,路由是指用户请求的URL与视图函数之间的映射。Flask框架 根据HTTP请求的URL在路由表中匹配预定义的URL规则,找到对应的视图函数, 并将视图函数的执行结果返回WSGI服务器:
可见路由表在Flask应用中处于相当核心的位置。路由表的内容是由应用开发者填充。
route装饰器 :可以使用Flask应用实例的route装饰器将一个URL规则绑定到 一个视图函数上。
例如,下面的示例将URL规则/test绑定到视图函数test()上:
@app.route('/test')
def test():
return 'this is response'
如果这个应用部署在主机ezhost.com的根目录下,那么当用户访问:
http://ezhost.com/teset
Flask框架就会调用我们的test()函数,其返回结果就传递给WSGI服务器发送给访问者。
add_url_rule() :另一种等价的写法是使用Flask应用实例的add_url_route()方法。 下面的示例注册了一个与前例相同的路由:
def test():
return 'this is response'
app.add_url_route('/test',view_func=test)
其实,route装饰器内部也是通过调用add_url_route()方法实现的路由注册。 但是显然,使用装饰器使代码看起来更优雅一些。
默认情况下,Flask路由仅支持HTTP的GET请求。可以使用methods关键字参数,在注册 路由时显式地声明视图方法支持的HTTP方法。
例如,下面的示例将URL规则/auth绑定到视图函数v_auth(),这个路由仅支持POST方法:
@app.route('/auth',methods=['POST'])
def v_auth():pass
指定多种HTTP方法支持
关键字参数methods的类型为list,因此可以同时指定多种HTTP方法。
下面的示例中,使URL规则/user同时支持POST方法和GET方法:
@app.route('/user',methods=['POST','GET'])
def v_users():
if request.method == 'GET':
return ... # 返回用户列表
if request.method == 'POST'
return ... #创建新用户
这个特性使Flask非常易于开发REST架构的后台服务,而不仅仅局限于传统的动态网页。
有时我们需要将同一类URL映射到同一个视图函数处理,比如,使用同一个视图函数 来显示不同用户的个人档案。我们希望以下的URL都可以分发到同一个视图函数:
在Flask中,可以将URL中的可变部分使用一对小括号<>声明为变量, 并为视图函数声明同名的参数:
@app.route('/user/<uname>')
def v_user(uname):
return '%s\'s Profile' % uname
</uname>
在上面的示例中,URL规则中的<uname>表示这部分是可变的,Flask将提取用户请求的 URL中这部分的内容,并作为视图函数v_user()的uname参数进行调用。
考虑下面的示例,我们希望通过HTTP共享文件夹/var/readonly中的文件:
/var
/readonly
/a.txt
/b.txt
/repo
/c.txt
/d.txt
简单思考一下就有答案了。我们可以构造URL规则/file/<fname>,然后直接 读取文件内容返回给用户。注册如下的路由:
@app.route('/file/<fname>')
def v_file(fname):
fullname = os.path.join('/var/readonly',fname)
f = open(fullname)
cnt = f.read()
f.close()
return cnt
</fname>
测试结果表明,/file/a.txt和/file/b.txt都没有问题,但是/file/repo/c.txt和 /file/repo/d.txt却会失败。
这是因为,默认情况下,在URL规则中的变量被视为不包含/的字符串。/file/repo/c.txt 是没有办法匹配URL规则/file/<fname>的。
可以使用内置的path转换器告诉Flask框架改变这一默认行为。path转换器允许 规则匹配包含/的字符串:
@app.route('/file/<path:fname>')
</path:fname>
在Flask中,转换器/converter用来对从URL中提取的变量进行预处理,这个过程 发生在调用视图函数之前。Flask预置了四种转换器:
我们一直强调,路由的作用是根据请求的URL,找到对应的视图函数。这没错,但是在 Flask框架中,请求任务的分发并不是直接从用户请求的URL一步定位到视图函数, 两者之间隔着一个访问点/endpoint。
以下面的代码为例,我们看Flask怎样实现请求的分发:
@app.route('/home')
def home():pass
在Flask内部使用两张表维护路由:
以用户访问URL/home为例,Flask将首先利用url_map找到所请求URL对应的 endpoint,即访问点home,然后再利用view_functions表查找home这个访问点 对应的视图函数,最终匹配到函数home():
默认访问点 :当我们使用route装饰器注册路由时,默认使用被装饰函数的 函数名(name)作为访问点,因此,你看到上面的表中,路由中的访问点为home。
自定义访问点 :可以在使用route装饰器或调用add_url_rule()方法注册路由时,使用 endpoint关键字参数改变这一默认行为:
@app.route('/home',endpoint='whocare')
def home():pass
此时的两张路由表将变成这样:
当创建应用实例时,Flask将自动添加一条静态目录路由,其访问点 始终被设置为static,URL规则默认被设置为/static,本地路径默认被 设置为应用文件夹下的static子文件夹:
+------------------------------------------------------------+ | url rule | endpoint | view_function | | /static | static | Flask.send_static_file | +------------------------------------------------------------+ 如果你的应用目录如下:
/app
/web.py
/static
/main.css
/jquery.min.js
那么启动应用后就可以通过URL/static/main.css访问static文件夹下的main.css了。
除了访问点被固定为static,静态目录的URL规则和本地目录都是可以根据应用情况进行调整。
改变默认的本地路径 :可以在创建应用对象时使用关键字参数static_folder改变 默认的静态文件夹。例如,你的静态文件都存放在应用下的assets目录下, 那么可以按如下的方式创建应用对象:
app = Flask(name,static_folder='assets') 也可以使用一个绝对路径:
app = Flask(name,static_folder='/var/www/static') 改变默认的本地路径并不会对路由表产生影响。
改变默认的URL规则 : 如果不喜欢静态目录URL/static,也可以在创建应用 对象时使用关键字参数static_url_path换一个别的名字。
下面的示例中,将应用下的assets文件夹注册为静态目录/assets:
app = Flask(name,static_folder='assets',static_url_path='/assets') 当应用运行后,通过URL/assets/main.css就可以访问assets文件夹下的 main.css文件了。
这时的路由表变化为:
+------------------------------------------------------------+ | url | endpoint | view_function | | /assets | static | Flask.send_static_file | +------------------------------------------------------------+
在一个实用的视图中,不可避免地存在指向其他视图的链接。在之前的课程示例中,我们 都是在视图函数中这样硬编码这些链接URL的:
@app.route('/')
def v_index():
return '<a href="/tech">tech</a>'
@app.route('/tech')
def v_tech():pass
大部分情况下这种硬编码URL是可以工作的。但如果这个应用被挂在WSGI服务器的一个 子路径下,比如:/app1,那么用户访问URL/tech是不会成功的,这时应当访问/app1/tech 才可以正确地路由到视图函数v_tech()。
我们应当使用访问点让Flask框架帮我们计算链接URL。简单地给url_for()函数传入 一个访问点,它返回将是一个可靠的URL地址:
@app.route('/')
def v_index():
print url_for('v_contacts') # /contact
return 'see console output!'
@app.route('/contact')
def v_contacts():pass
添加查询参数 : 使用关键字参数,可以在构造的URL中生成查询串。下面的调用将生成 /contact?format=json
@app.route('/')
def v_index():
print url_for('v_contacts',format='json')
return ''
@app.route('/contact')
def v_contacts():pass
添加URL变量 : 如果指定访问点对应的视图函数接收参数,那么关键字参数将生成对应的参数URL。下面的 示例将生成/contact/Julia?format=html:
@app.route('/')
def v_index():
print url_for('v_contact',name='Julia',format='html')
return ''
@app.route('/contact/<name>')
def v_contact(name):pass
</name>
添加锚点 :使用_anchor关键字可以为生成的URL添加锚点。下面的示例将生成URL /contact#part2
@app.route('/')
def v_index():
print url_for('v_contacts',_anchor='part2')
@app.route('/contact')
def v_contacts():pass
外部URL : 默认情况下,url_for()生成站内URL,可以设置关键字参数_external 为True,生成包含站点地址的外部URL。下面的示例将生成URLhttp://<x.y.z>/contacts:
源:Python爬虫与数据挖掘
作者:Python进阶者
今天来给大家说一个Python的轻量级web开发框架-------Flask,为什么要推荐它呢?当然是因为它够轻量级了,开发迅速是它的特点,当然它也有缺点,不过这里不说,因为既用它又说它差感觉不好。
pip install flask #需要注意的是,还有flake,那个是检查错误的模块,不要搞混了
可以看到成功了,总共下载了四个模块,分别是对应的web开发中的模板渲染,网络服务都是一些flask依赖包。
1.启动
既然说到用法,那第一个就肯定得说说它是怎么启动的,不然别人哪里还学的下去啊,废话少说,开干。
from flask import Flask
app=Flask(__name__) #创建应用实例
@app.route('/') # route装饰器创建路由
def hello(): # 访问此路由时执行的视图函数
return 'hello' # 视图函数的返回值,又叫‘响应’
if __name__ == '__main__':
app.run(debug=True) #开始运行flask应用程序,以调试模式运行
#可以设置启动的host地址和端口号,具体方法:
app.run(host='192.168.1.2',port=3243)
从上面可以看出,因为我修改了视图函数和返回值,只需在浏览器刷新即可,完全不用退出重启,sublime text 3真是神器啊,给力,墙裂建议大家使用。
2.创建Flask应用注意事项
要想创建一个Flask应用,首先我们要建立一个项目文件夹,里面至少要有两个文件夹,一个存放媒体文件(static),一个存放网页文件(templates),如果Python程序不多,可以不用给它单独建立文件夹。Flask不像Django一样可以自动创建文件夹,需要我们自己创建。如果你想查看flask创建的路由信息:
url_map存储的是url与endpoint的映射。那么这个endpoint是什么意思了?实际上,当请求传来一个url的时候,会先通过rule找到endpoint,然后再根据endpoint再找到对应的视图函数。通常,endpoint的名字都和视图函数名一样。这里还有一点特别注意,那就是所有的控制台输出信息语句必须写在app.run()之前,否则不起作用。
3.Flask的妙用
我们可以看到Flask里面有一个name,这个是为了启动模板专门设立的,除了这个,它还有:
static_url_path:静态网页地址
static_folder:静态地址,默认为static文件夹
template_folder:模板文件夹,默认为templates文件夹
4.添加配置文件
1)直接在app.run()函数里添加
比如以调试模式运行Flask应用就可以使用:app.run(debug=True)
2)直接配置
app.config=True
3)建立配置文件
在项目文件夹根目录建立一个配置文件夹,名字为 hw.hw,后缀名你随便取,内容为 DEBUG=True,然后在app.run()前面添加app.config.from_pyfile('hw.hw') 即可。
5.视图函数用法
1)下级页面
@app.route('/index')
def index():
return 'index'
2)转换器
@app.route('/index/<int:num>') #定义转换器名字num
def num(num): #将转换器传入函数中
if num>10: #如果它的值大于10输出dog,小于10输出pig
return 'dog'
else:
return 'pig'
这里需要说到的是,转换器主要是将页面后的值作为某一个标准来得到另一个页面,我们常看到的加密字符串就是用这个做的,那么它有哪些类型呢?
Flask的默认转换器:DEFAULT_CONVERTERS = {
‘default’: UnicodeConverter,
‘string’: UnicodeConverter,
‘any’: AnyConverter,
‘path’: PathConverter,
‘int’: IntegerConverter,
‘float’: FloatConverter,
‘uuid’: UUIDConverter,}
除此之外,我们也可以自定一转换器,定义转换器需要使用依赖包,方法如下:
class rc(BaseConverter):
# 重写父类的属性,定义转换器规则
def __init__(self,url_map):
super(rc,self).__init__(url_map)
#验证QQ邮箱的正则表达式
self.regex ='[0-9a-zA-Z_]{0,19}@qq.com'
#定义视图函数下的返回值
def to_python(self,value):
val=value
return val
def to_url(self,value):#返回url
return value
app.url_map.converters['em'] = rc #将自定义的转换器添加到转换器列表中
@app.route('/emm/<em:email>') #加入新的转换器
def email(email):
return 'email is:%s' % email #返回email
可以通过反向解析将添加了自定义转换器的视图函数拿来用,这里需要用到重定向和反向解析:
@app.route('/search')
def jj():
url=url_for('email',email='2091500484@qq.com')
return redirect(url)
如果不注明转换器类型,就是默认的字符串型:
@app.route('/hw/<boy>')
def hw(boy):
return 'boy:%s'%boy
还可以定义默认的转换器的默认值:
@app.route('/ha/<string:haid>',defaults={'haid':'hello,boy'}) #设置默认值
def ha(haid):
return 'haid:%s'%haid
3)多个路由指向同一地址
@app.route('/1')
@app.route('/2')
def fg():
return '1122'
这里访问下级页面1或者页面2都会得出同样的结果’1122‘
6.重定向
重定向即是指从一个网页跳转到另一个网页,相当于刷新之后的操作,这里涉及到flask里的两个模块(redirect,url_for)。
1)直接跳转
直接跳转到路由下
from flask import redirect,url_for
@app.route('/refer')
def refer():
return redirect('/1')
这样就可以直接跳转到路由函数fg中并显示返回值。
2)间接跳转
我们可以先访问路由函数,然后跳转到相应内容页面
@app.route('/ref')
def ref():
return redirect(url_for('fg')) #跳转
这样直接访问ref子页面就可以直接跳转到相应页面了
7.定义错误页面
有两种方式,一是使用系统的abort直接赋值,二是使用自定义errorhandler函数。
1)abort
直接使用系统自带的错误内容
@app.route('/use/<id>')
def get_use(id):
if int(id)<10:
abort(404)
elif int(id)>20:
return '---Error---'
return 'hello:%s'%str(id)
2)errorhandler
自定义错误页面内容
@app.errorhandler(404)
def error(err):
return 'hello,%s'%err
3)定义错误页面
它可以将自定义的错误写入到页面中,平时会用的比较多。
@app.route('/error1')
def err1():
error1=('index error',666,[('key','div'),('value','zero')])
return error1
当然还有一种表述方式:
@app.route('/error2')
def err2():
error2=('login error',444,{'serise':'100','dataframe':'200'})
return error2
4)设置请求
这里需要说到一个新的模块make_response(),当然你也可以使用Response()。
@app.route('/error3')
def err3():
resp=make_response('search error') #这里只需把make_response()换成Response()即可
resp.status='400'
resp.headers['hrr']='zjj'
resp.headers['hw']='zj'
return resp
8.json数据读取
flask中有个非常给力的可以处理json数据的模块,jsonify。
@app.route('/json1')
def json1():
data={'name':'HW','first':'ZJ'}
return jsonify(data)
@app.route('/json2')
def json2():
return jsonify(hour=12,second=21)
9.cookie的操作
1)设置cookie
#cookie的设置
#set_cookie(key, value='', max_age=None, expires=None,path='/', domain=None, secure=False, httponly=False,samesite=None)
#key:键
#value:值
#max_age:设置过期时间(秒)
#expires:设置过期时间,时间戳的形式(1970离现在的时间)
#path:当前主域名
#domain:子域名
#设置cookie和headers
@app.route('/set_cookie')
def set_cookie():
response=make_response('cookie设置成功')
#cookie有效时长30天也可以是hour second minute
time=datetime.datetime.today()+datetime.timedelta(days=30)#设置cookie的有效时长
response.set_cookie('user','admin',expires=time) #设置用户名的cookie
response.set_cookie('pass','123456',expires=time) #设置密码的cookie
response.headers['X-Something']='mything' #这里不允许出现中文
response.headers['Server']='Linux' #服务器名称
return response
2)获取cookie
这里需要用到一个模块request,它相当于模拟一个请求,你可以把它当做requests模块一样。
@app.route('/get_cookie')
def get_cookie():
name="用户名:"+request.cookies.get('user')+"密码:"+request.cookies.get('pass')
return name
3)删除cookie
有两种删除方式来删除cookie。
1.通过设置cookie过期时间为0即可删除
@app.route('/del_cookie1')
def del_cookie1():
response=make_response('delete cookie 1')
response.set_cookie('user','',expires=0)
response.set_cookie('pass','',expires=0)
return response
2.直接删除cookie
@app.route('/del_cookie2')
def del_cookie2():
response=make_response('delete cookie 2')
response.delete_cookie('user')
response.delete_cookie('pass')
return response
10.session操作
session里面保留的就是会话内容,它存在于cookie当中,通过它我们可以直接登陆某些已经登陆过的系统。要想操作session我们需要引入为它专门准备的session模块,还有需要配置安全秘钥才可以使用session。
1)设置session
一、配置安全秘钥:
app.config['SECRET_KEY']=os.urandom(30)
二、设置session字典
session['user']='hw'
session['pass']='zj'
三、设置session过期方式
session.parmanent=True #默认31天后过期
#session两个小时过期
app.config['PERMANENT_SESSION_LIFETIME']= timedelta(hour=2)
四、综合代码
@app.route('/session1')
def session1():
session['user']='hw'
session['pass']='zj'
session.parmanent=True #默认31天后过期
return 'login success'
可以看到session成功设置在cookie里面了,并且浏览器也记录了。当然你也可以只设置cookie,不过为了安全建议你设置session。
2)获取session
跟cookie获取有点不同。
一、get()获取
@app.route('/session2')
def session2():
us=session.get("user")
pa=session.get("pass")
return 'hello %s %s'%(us,pa)
二、索引获取
这种方式如果获取不到值容易产生异常,建议用上一种方法,除非你知道一定能获取到值。
@app.route('/session2')
def session2():
us=session["user"]
pa=session["pass"]
return 'hello %s %s'%(us,pa)
3)删除session
也有两种方法,不过一种是一个一个删除,另一种则是全部删除。
一、逐一删除
@app.route('/session3')
def session3():
session.pop('user',None)
session.pop('pass',None)
return 'delete successful!!!!'
二、全部删除
@app.route('/session4')
def session4():
session.clear()
return 'delete successful!!!!'
11.总结
本文着重讲解了Flask的最基础的用法,Flask是一个十分优秀的web开发框架,它可以十分迅速的开发出web应用,但是它需要依赖众多的包才能完善更多的功能。这里只是讲述了Flask一半的知识,下一篇文章,继续给大家盘点,一起学习,共同进步!
eb应用程序通常需要一个静态文件,例如支持显示网页的JavaScript文件或CSS文件。 通常,可以通过配置Web服务器提供这些服务,但在开发过程中,这些文件将从包中的静态文件夹或模块旁边提供,它将在应用程序的/static上提供。
使用特殊的端点“静态”来为静态文件生成URL。
在以下示例中,index.html中的HTML按钮的OnClick事件调用hello.js中定义的javascript函数,该函数在Flask应用程序的URL => / 中呈现。
示例
# Filename : example.py
# Copyright : 2020 By Nhooo
# Author by : www.cainiaojc.com
# Date : 2020-08-08
from flask import Flask, render_template
app = Flask(__name__)
@app.route("/")
def index():
return render_template("index.html")
if __name__ == '__main__':
app.run(debug = True)
index.html 中的HTML脚本如下所示。
# Filename : example.py
# Copyright : 2020 By Nhooo
# Author by : www.cainiaojc.com
# Date : 2020-08-08
<html>
<head>
<script type = "text/javascript"
src = "{{ url_for('static', filename = 'hello.js') }}" ></script>
</head>
<body>
<input type = "button" onclick = "sayHello()" value = "Say Hello" />
</body>
</html>
文件: hello.js 中定义包含 sayHello() 函数。
*请认真填写需求信息,我们会在24小时内与您取得联系。