Flask - Variable Rule

Introduction to Flask Variable Rule

Flask’s routing system is highly flexible, allowing you to capture parts of the URL as variables. These variable rules enable dynamic routing, where your application can respond differently based on the URL parameters provided by the user.

What Are Variable Rules?

Variable rules in Flask are placeholders within the URL that accept input from the client. These inputs are then passed as arguments to the corresponding view function. This mechanism helps build dynamic routes that can handle a variety of inputs without defining multiple static routes.

Defining a Route with Variable Rules

To create a variable route, use angle brackets <> inside the route decorator to specify the variable part. For example:

@app.route('/user/<username>')
def show_user(username):
    return f'User Profile: {username}'

Here, username is a variable captured from the URL. Visiting /user/Alice would display “User Profile: Alice”.

Using Converters with Variable Rules

Flask allows you to specify data types for variables using converters. This ensures the variable follows a specific format, such as integers or paths. Common converters include:

• string: (default) accepts any text except slash
• int: accepts integers only
• float: accepts floating point values
• path: like string but accepts slashes

@app.route('/post/<int:post_id>')
def show_post(post_id):
    return f'Post ID: {post_id}'

This route matches only if post_id is an integer.

Multiple Variable Rules in One Route

You can include multiple variables in a single route. Flask will pass each one to your function as separate arguments:

@app.route('/order/<int:order_id>/item/<:string:item_name>')
def order_item(order_id, item_name):
    return f'Order {order_id}: Item {item_name}'

This lets you capture complex URLs and use the data in your application logic.

Summary

Flask’s variable rules make URL routing flexible and powerful by allowing you to capture user input directly from URLs. Using converters enhances type safety and route precision, enabling you to build clean and efficient web applications tailored to user requests.