URL Building (url_for)

Hardcoding routes like "/user/123" is fragile.

If you rename the route later, you must update every place that used the string.

Flask’s best practice is to generate URLs with url_for().

diagram build URLs from the endpoint, never by concatenating strings mermaid

  flowchart LR
  A["url_for('user', name='ada')"] --> B["look up the endpoint 'user'"]
  B --> C["find its rule /user/<name>"]
  C --> D["fill the placeholders, percent-encoding as needed"]
  D --> E["/user/ada"]
  F["extra kwargs"] --> G["appended as a query string"]
  H["_external=True"] --> I["absolute: http://host/user/ada"]
  J["_anchor='top'"] --> K["adds #top"]

url_for goes from an endpoint name and some values to a path, using the same rules the router uses to match. That means a route can be renamed in one place, extra keyword arguments become the query string, and values are percent-encoded on the way in. It is also the only form that stays correct once the app is mounted under a prefix or served as a blueprint.

url_for encodes spaces but not slashes

A value containing a slash silently produces a URL that does not match the rule it came from. Verified:

Call	Produces	Fetching it
url_for('user', name='ada')	/user/ada	200
url_for('user', name='a b c')	/user/a%20b%20c	200 — round-trips fine
url_for('user', name='a b/c')	/user/a%20b/c	404

The space became %20, but the / was left as a separator — so the generated path has one segment too many and no longer matches /user/<name>, which does not accept slashes.

It matters wherever a user-supplied value goes into a path segment: a filename, a slug, a title. Either slugify the value first, or put it in the query string where slashes are harmless, or use <path:...> if a slash genuinely belongs there.

Basic usage

python

from flask import Flask, url_for
 
app = Flask(__name__)
 
 
@app.route("/")
def home():
    profile_url = url_for("profile", username="ravi")
    return f"Profile link: {profile_url}"
 
 
@app.route("/user/<username>")
def profile(username):
    return f"Profile: {username}"

Key idea:

• You pass the endpoint name (usually the function name)
• And any variables required by the route

Why url_for is important

• avoids broken links after refactors
• supports query parameters cleanly
• supports Blueprints (namespaced endpoints)

Query parameters with url_for

python

url_for("search", q="flask", page=2)

Output (conceptually):

• /search?q=flask&page=2

Static files

You’ll use:

python

url_for("static", filename="styles.css")

That’s how templates should reference CSS/JS.

Debugging: what is my endpoint name?

Run:

bash

flask routes

It lists endpoints and URL rules.