Flask中endpoint的理解(小结)


Posted in Python onDecember 11, 2019

在flask框架中,我们经常会遇到endpoint这个东西,最开始也没法理解这个到底是做什么的。最近正好在研究Flask的源码,也就顺带了解了一下这个endpoint

首先,我们看一个例子:

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

这个是我们在用flask框架写网站中最常用的。

通过看源码,我们可以发现:

函数等效于

def user(name)
  return 'Hello, %s' % name
  
app.add_url_rule('/user/<name>', 'user', user)

这个add_url_rule函数在文档中是这样解释的:

add_url_rule(*args, **kwargs)
 Connects a URL rule. Works exactly like the route() decorator. If a view_func is provided it will be registered with the endpoint.

add_url_rule有如下参数:

rule ? the URL rule as string
endpoint ? the endpoint for the registered URL rule. Flask itself assumes the name of the view function as endpoint
view_func ? the function to call when serving a request to the provided endpoint
options ? the options to be forwarded to the underlying Rule object. A change to Werkzeug is handling of method options. methods is a list of methods this rule should be limited to (GET, POST etc.). By default a rule just listens for GET (and implicitly HEAD). Starting with Flask 0.6, OPTIONS is implicitly added and handled by the standard request handling.

抛开options这个参数不谈,我们看看前三个参数。
rule:这个参数很简单,就是匹配的路由地址
view_func:这个参数就是我们写的视图函数
endpoint:这个参数就是我今天重点要讲的,endpoint

很多人认为:假设用户访问http://www.example.com/user/eric,flask会找到该函数,并传递name='eric',执行这个函数并返回值。

但是实际中,Flask真的是直接根据路由查询视图函数么?

在源码中我们可以发现:

  • 每个应用程序app都有一个view_functions,这是一个字典,存储endpoint-view_func键值对。add_url_rule的第一个作用就是向view_functions中添加键值对(这件事在应用程序run之前就做好了)
  • 每个应用程序app都有一个url_map,它是一个Map类(具体实现在werkzeug/routing.py中),里面包含了一个列表,列表元素是Role的实例(werkzeug/routing.py中)。add_url_rule的第二个作用就是向url_map中添加Role的实例(它也是在应用程序run之前就做好了)

我们可以通过一个例子来看:

app = Flask(__name__)

@app.route('/test', endpoint='Test')
def test():
  pass


@app.route('/', endpoint='index')
def hello_world():
  return 'Hello World!'

if __name__ == '__main__':
  print(app.view_functions)
  print(app.url_map)
  app.run()

运行这个程序,结果是:

{'static': <bound method Flask.send_static_file of <Flask 'flask-code'>>, 'Test': <function test at 0x10065e488>, 'index': <function hello_world at 0x10323d488>}
Map([<Rule '/test' (HEAD, OPTIONS, GET) -> Test>,
 <Rule '/' (HEAD, OPTIONS, GET) -> index>,
 <Rule '/static/<filename>' (HEAD, OPTIONS, GET) -> static>])
 * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)

所以我们可以看出:这个url_map存储的是url与endpoint的映射!

回到flask接受用户请求地址并查询函数的问题。实际上,当请求传来一个url的时候,会先通过rule找到endpoint(url_map),然后再根据endpoint再找到对应的view_func(view_functions)。通常,endpoint的名字都和视图函数名一样。

这时候,这个endpoint也就好理解了:

实际上这个endpoint就是一个Identifier,每个视图函数都有一个endpoint,

当有请求来到的时候,用它来知道到底使用哪一个视图函数

在实际应用中,当我们需要在一个视图中跳转到另一个视图中的时候,我们经常会使用url_for(endpoint)去查询视图,而不是把地址硬编码到函数中。

这个时候,我们就不能使用视图函数名当endpoint去查询了

我们举个例子来说明。比如:

app = Flask(__name__)
app.register_blueprint(user, url_prefix='user')
app.register_blueprint(file, url_prefix='file')

我们注册了2个蓝图。

在user中(省略初始化过程):

@user.route('/article')
def article():
  pass

在file中(省略初始化过程):

@file.route('/article')
def article():
  pass

这时候,我们发现,/article这个路由对应了两个函数名一样的函数,分别在两个蓝图中。当我们使用url_for(article)调用的时候(注意,url_for是通过endpoint查询url地址,然后找视图函数),flask无法知道到底使用哪个蓝图下的endpoint,所以我们需要这样:

url_for('user.article')

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持三水点靠木。

Python 相关文章推荐
Python基于PycURL自动处理cookie的方法
Jul 25 Python
深入解析Python中的上下文管理器
Jun 28 Python
解决Python安装后pip不能用的问题
Jun 12 Python
Selenium元素的常用操作方法分析
Aug 10 Python
pygame游戏之旅 添加游戏暂停功能
Nov 21 Python
在python中使用xlrd获取合并单元格的方法
Dec 26 Python
我们为什么要减少Python中循环的使用
Jul 10 Python
python 多维高斯分布数据生成方式
Dec 09 Python
tensorflow实现将ckpt转pb文件的方法
Apr 22 Python
Python实现SMTP邮件发送
Jun 16 Python
keras和tensorflow使用fit_generator 批次训练操作
Jul 03 Python
如何通过python实现IOU计算代码实例
Nov 02 Python
Python中Flask-RESTful编写API接口(小白入门)
Dec 11 #Python
Python zip函数打包元素实例解析
Dec 11 #Python
基于Python实现扑克牌面试题
Dec 11 #Python
Python如何使用argparse模块处理命令行参数
Dec 11 #Python
opencv3/C++ 平面对象识别&amp;透视变换方式
Dec 11 #Python
Python Lambda函数使用总结详解
Dec 11 #Python
Python迭代器模块itertools使用原理解析
Dec 11 #Python
You might like
prototype 1.5 &amp; scriptaculous 1.6.1 学习笔记
2006/09/07 Javascript
关于文本限制字数的js代码
2007/04/02 Javascript
javascript五图轮播切换实用版
2012/08/17 Javascript
jQuery实现网页顶部固定导航效果代码
2015/12/24 Javascript
JavaScript简单实现鼠标移动切换图片的方法
2016/02/23 Javascript
JavaScript笔记之数据属性和存储器属性
2016/03/31 Javascript
jQuery解决浏览器兼容性问题案例分析
2016/04/15 Javascript
Javascript实现跑马灯效果的简单实例
2016/05/31 Javascript
全面解析node 表单的图片上传
2016/11/21 Javascript
详解JavaScript的闭包、IIFE、apply、函数与对象
2016/12/21 Javascript
浅谈ECMAScript6新特性之let、const
2017/08/02 Javascript
layui select动态添加option的实例
2018/03/07 Javascript
vue项目部署上线遇到的问题及解决方法
2018/06/10 Javascript
angular 实现的输入框数字千分位及保留几位小数点功能示例
2018/06/19 Javascript
vue中v-for通过动态绑定class实现触发效果
2018/12/06 Javascript
JavaScript实现指定数量的并发限制的示例代码
2020/03/10 Javascript
vue+ElementUI 关闭对话框清空验证,清除form表单的操作
2020/08/06 Javascript
Vuex实现购物车小功能
2020/08/17 Javascript
[39:18]完美世界DOTA2联赛PWL S3 Forest vs LBZS 第二场 12.17
2020/12/19 DOTA
深入浅析ImageMagick命令执行漏洞
2016/10/11 Python
Pycharm编辑器技巧之自动导入模块详解
2017/07/18 Python
Python生态圈图像格式转换问题(推荐)
2019/12/02 Python
Python3实现mysql连接和数据框的形成(实例代码)
2020/01/17 Python
宝塔面板成功部署Django项目流程(图文)
2020/06/22 Python
Pytorch 卷积中的 Input Shape用法
2020/06/29 Python
Python Pandas数据分析工具用法实例
2020/11/05 Python
css3边框_动力节点Java学院整理
2017/07/11 HTML / CSS
HTML5 新事件 小结
2009/07/16 HTML / CSS
彪马法国官网:PUMA法国
2019/12/15 全球购物
经济管理专业毕业生推荐信
2013/11/11 职场文书
半年思想汇报
2013/12/30 职场文书
酒店餐厅2014重阳节活动策划方案
2014/09/16 职场文书
python 下载文件的几种方式分享
2021/04/07 Python
pytorch加载预训练模型与自己模型不匹配的解决方案
2021/05/13 Python
深入解析Apache Hudi内核文件标记机制
2022/03/31 Servers
Golang并发工具Singleflight
2022/05/06 Golang