Skip to main content

Using URL converters

In this tutorial, we'll explore how to use URL converters in Flask. Before we start, make sure you have Flask installed and ready to go on your local system. If not, you can easily install it using pip:

pip install flask

Flask routing allows the application to perform different actions based on the URL accessed. URL converters further enhance this by providing dynamic behavior in the URLs. This means that parts of the URL can be variables, and Flask can process these variables to decide what action to take.

Basic Routing in Flask​

Before we dive into URL converters, let's quickly review how basic routing works in Flask:

from flask import Flask
app = Flask(__name__)

@app.route('/')
def home():
    return 'Home Page'

@app.route('/about')
def about():
    return 'About Page'

In this example, we have two routes, '/' and '/about'. When a user accesses these URLs, Flask will call the corresponding function and return the response.

Using URL Converters​

To use URL converters, you need to place the variable part in angle brackets like <variable_name>. You can then use this variable in your view function. Let's see how this works with an example:

@app.route('/user/<username>')
def show_user_profile(username):
    return 'User %s' % username

In this case, if a user navigates to /user/john, Flask will call the show_user_profile function with username set to 'john'.

Types of URL Converters​

Flask supports several types of URL converters out of the box:

  1. string: (default) accepts any text without a slash.
  2. int: accepts positive integers.
  3. float: similar to int but for floating point values.
  4. path: similar to string but also accepts slashes.
  5. uuid: accepts UUID strings.

Here's how you can use these converters:

@app.route('/post/<int:post_id>')
def show_post(post_id):
    return 'Post %d' % post_id

@app.route('/path/<path:subpath>')
def show_subpath(subpath):
    return 'Subpath %s' % subpath

In the first route, post_id must be an integer. If a user navigates to /post/3, Flask will call the show_post function with post_id set to 3. However, if a user tries to navigate to /post/three, Flask will return a 404 error because 'three' is not an integer.

In the second route, subpath can contain slashes, such as first/second. If a user navigates to /path/first/second, Flask will call the show_subpath function with subpath set to 'first/second'.

Conclusion​

URL converters allow you to add dynamic behavior to your Flask routes. They make it easy to create URLs that can change based on the data sent to the server. This flexibility can greatly simplify your code and make your application more robust and easier to maintain. We hope this tutorial helps you understand how to use URL converters effectively in your Flask applications. Happy coding!