Flask: get current route

Question

In Flask, when I have several routes for the same function, how can I know which route is used at the moment?

For example:

@app.route("/antitop/")
@app.route("/top/")
@requires_auth
def show_top():
    ....

How can I know, that now route was called using /top/ or /antitop/?

UPDATE

I know about request.path I don't want use it, because the request can be rather complex, and I want repeat the routing logic in the function. I think that the solution with url_rule it the best one.

http://stackoverflow.com/a/15975041/743775 should do? – Nipun Batra Feb 01 '14 at 13:39 — Nipun Batra, Feb 01 '14 at 13:39

falsetru · Answer 1 · 2014-02-01T13:44:30.927

105

Simply use request.path.

from flask import request

...

@app.route("/antitop/")
@app.route("/top/")
@requires_auth
def show_top():
    ... request.path ...

edited Feb 01 '14 at 13:44

answered Feb 01 '14 at 13:39

falsetru

336,967
57
673
597

26

Upvoting simply because you bothered with the import statement. – Michael Scheper Apr 25 '17 at 23:29
1

@MichaelScheper Agreed, so many code snippets for ANY type of code don't include import statements – OzzyTheGiant Sep 15 '21 at 17:36

score 69 · Accepted Answer · edited Dec 16 '18 at 16:32

69

the most 'flasky' way to check which route triggered your view is, by request.url_rule.

from flask import request

rule = request.url_rule

if 'antitop' in rule.rule:
    # request by '/antitop'

elif 'top' in rule.rule:
    # request by '/top'

edited Dec 16 '18 at 16:32

Martin Thoma

108,021
142
552
849

answered Feb 01 '14 at 13:40

thkang

10,747
12
62
81

4

This is a good solution but consider @marcinkuzminski 's solution . I think it is more elegant. – Ezequiel May 09 '19 at 14:33
This fails if the route is a [variable rule](https://flask.palletsprojects.com/en/2.0.x/quickstart/#variable-rules) `@app.route('/user/')` – gerardw Jun 26 '21 at 16:23
@gerardw `request.url_rule.rule` is the thing. It returns `/user/` as really needed. – winwin Sep 29 '21 at 13:54

score 56 · Answer 3 · answered Mar 14 '15 at 20:48

56

Another option is to use endpoint variable:

@app.route("/api/v1/generate_data", methods=['POST'], endpoint='v1')
@app.route("/api/v2/generate_data", methods=['POST'], endpoint='v2')
def generate_data():
    version = request.endpoint
    return version

answered Mar 14 '15 at 20:48

marcinkuzminski

1,671
14
11

That shows the route with dots instead of slashes. That is, `subunit.page` instead of `/subunit/page` – gerardw Jun 26 '21 at 20:53

score 9 · Answer 4 · answered Feb 01 '14 at 15:51

If you want different behaviour to each route, the right thing to do is create two function handlers.

@app.route("/antitop/")
@requires_auth
def top():
    ...

@app.route("/top/")
@requires_auth
def anti_top():
    ...

In some cases, your structure makes sense. You can set values per route.

@app.route("/antitop/", defaults={'_route': 'antitop'})
@app.route("/top/", defaults={'_route': 'top'})
@requires_auth
def show_top(_route):
    # use _route here
    ...

score 1 · Answer 5 · answered Feb 01 '14 at 13:39

1

It seems to me that if you have a situation where it matters, you shouldn't be using the same function in the first place. Split it out into two separate handlers, which each call a common fiction for the shared code.

answered Feb 01 '14 at 13:39

Daniel Roseman

567,968
59
825
842

1

I think that the solution with `url_rule` is the best one, but thank you anyway and +1 – Igor Chubin Feb 01 '14 at 13:49

Flask: get current route

5 Answers5

Linked