Flask中endpoint的理解

在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/ericflask会找到该函数,并传递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存储的是urlendpoint的映射!

回到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‘)

原文地址:https://www.cnblogs.com/fengff/p/9088907.html

时间: 2024-10-20 07:40:18

Flask中endpoint的理解的相关文章

Flask中&#39;endpoint&#39;(端点)的理解

Flask路由是如何工作的 整个flask框架(及以Werkzeug类库为基础构建的应用)的程序理念是把URL地址映射到你想要运行的业务逻辑上(最典型的就是视图函数),例如: @app.route('/greeting/<name>') def give_greeting(name): return 'Hello, {0}!'.format(name) 1 2 3 注意,add_url_rule函数实现了同样的目的,只不过没有使用装饰器,因此,下面的程序是等价的: # 抬头没有使用路由装饰器,

FlASK中的endpoint问题

先贴一点有关的flask代码,时间有限,我慢慢扩充 以下是flask源码中app.py中add_url_rule的代码. 主要是view_func  -- endpoint -- url 之间的对应关系. flask中,view_func与url并不是直接对应的,是url先找到endpoint, 然后通过endpoint再去找到对应的view_func,一个endpoint只能对应于一个view_func,在注册add_url_rule的时候,如果不指定endpoint,那么endpoint就会

flask中的endpoint、自定义转化器、与djnago中session区别、利用装饰器实现登录认证

flask路由中的endpoint 与自定义转化器 ''' endpoint主要用于 反向解析, 例如:login函数中配的路由是/login,其中endpoint='lg' 则在其他函数,可以用 url=url_for('lg'),redirect(url)直接访问login函数 ''' ''' 自定义转化器,可以用来动态更新url_for 的跳转路由 其中 to_python主要是给后端的,可以对路由参数做修改 to_url是给前端url的,可以更新指定的url ''' flask与djan

Flask最强攻略 - 跟DragonFire学Flask - 第七篇 Flask 中路由系统

Flask中的路由系统其实我们并不陌生了,从一开始到现在都一直在应用 @app.route("/",methods=["GET","POST"]) 为什么要这么用?其中的工作原理我们知道多少? 请关注跟DragonFire学Flask 之 路由系统 ,这里有你想要的答案 1. @app.route() 装饰器中的参数 如果不明白装饰器 点击这里 methods : 当前 url 地址,允许访问的请求方式 @app.route("/inf

Flask最强攻略 - 跟DragonFire学Flask - 第九篇 Flask 中的蓝图(BluePrint)

蓝图,听起来就是一个很宏伟的东西 在Flask中的蓝图 blueprint 也是非常宏伟的 它的作用就是将 功能 与 主服务 分开怎么理解呢? 比如说,你有一个客户管理系统,最开始的时候,只有一个查看客户列表的功能,后来你又加入了一个添加客户的功能(add_user)模块, 然后又加入了一个删除客户的功能(del_user)模块,然后又加入了一个修改客户的功能(up_user)模块,在这个系统中,就可以将 查看客户,修改客户,添加客户,删除客户的四个功能做成蓝图加入到客户管理系统中,本篇最后会做

Flask中的请求上下文和应用上下文

本文章粘贴自 https://blog.tonyseek.com/post/the-context-mechanism-of-flask/ 用过 Flask 做 Web 开发的同学应该不会不记得 App Context 和 Request Context 这两个名字--这两个 Context 算是 Flask 中比较特色的设计.[1] 从一个 Flask App 读入配置并启动开始,就进入了 App Context,在其中我们可以访问配置文件.打开资源文件.通过路由规则反向构造 URL.[2] 

flask中的蓝图与子域名实现

内容: 1.flask中的蓝图 2.flask子域名实现 1.flask中的蓝图 一个大型项目中视图比较多,如果仅仅是写在app.py中不方便管理,蓝图就可以做到分功能分目录结构 (1)什么是蓝图 蓝图:用于实现单个应用的视图.模板.静态文件的集合. 蓝图就是模块化处理的类 简单来说,蓝图就是一个存储操作路由映射方法的容器,主要用来实现客户端请求和URL相互关联的功能. 在Flask中,使用蓝图可以帮助我们实现模块化应用的功能. (2)蓝图的运行机制 蓝图是保存了一组将来可以在应用对象上执行的操

Flask初识,第九篇,Flask中的蓝图

蓝图,听起来就是一个很宏伟的东西 在Flask中的蓝图 blueprint 也是非常宏伟的 它的作用就是将 功能 与 主服务 分开怎么理解呢? 比如说,你有一个客户管理系统,最开始的时候,只有一个查看客户列表的功能,后来你又加入了一个添加客户的功能(add_user)模块, 然后又加入了一个删除客户的功能(del_user)模块,然后又加入了一个修改客户的功能(up_user)模块,在这个系统中,就可以将 查看客户,修改客户,添加客户,删除客户的四个功能做成蓝图加入到客户管理系统中,本篇最后会做

Flask中的蓝图(BluePrint)、

蓝图 1.初识Flask蓝图(BluePrint) 创建一个项目然后将目录结构做成: user.py中的内容 from flask import Blueprint, render_template # 导入Flask中的蓝图BluePrint模块 # 实例化一个蓝图对象 users_blue = Blueprint('users', __name__, template_folder='user_temp', url_prefix='/user') # 这里添加路由和视图函数的时候与在Flas