Route naming conventions in Flask - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the purpose of route naming conventions in Flask?

Route naming conventions help keep URLs clear, consistent, and easy to understand for both developers and users. They make the app easier to maintain and navigate.

beginner

Why should route names be lowercase and use hyphens instead of underscores?

Lowercase and hyphens improve readability and are more user-friendly in URLs. Hyphens separate words clearly, while underscores can be harder to spot in links.

intermediate

How should RESTful routes be named for resources in Flask?

Use plural nouns for resource names (e.g., '/users') and HTTP methods to define actions (GET for read, POST for create, PUT/PATCH for update, DELETE for delete).

beginner

What is a good practice for naming dynamic route parameters in Flask?

Use clear and descriptive names inside angle brackets, like '/user/<user_id>', so it’s obvious what data the route expects.

beginner

Why avoid using file extensions (like .html) in Flask route URLs?

Avoiding file extensions keeps URLs clean and flexible. It also separates the URL from the technology used to render the page, making future changes easier.

Which of these is the best route name for a list of blog posts in Flask?

A /blog-posts

B /BlogPosts

C /blog_posts

D /blogPosts

Using lowercase with hyphens ('/blog-posts') is the clearest and most readable convention for URLs.

How should you name a route that shows details for a single user?

A /user/<id>

B /users/<user_id>

C /user_id

D /users/id

Use plural resource name with a descriptive dynamic parameter: '/users/'.

Which HTTP method is typically used with the route '/users' to create a new user?

A GET

B DELETE

C POST

D PUT

POST is used to create new resources at the given route.

Why should URLs avoid including file extensions like '.html'?

A To make URLs shorter

B To improve server speed

C To allow spaces in URLs

D To keep URLs technology-independent and clean

Avoiding file extensions keeps URLs clean and independent of the rendering technology.

What is the recommended way to separate words in Flask route URLs?

A Hyphens (-)

B CamelCase

C Underscores (_)

D No separation

Hyphens improve readability and are preferred for separating words in URLs.

Explain the key principles of naming routes in Flask for a beginner.

Think about how URLs should look simple and clear for users and developers.

Describe how RESTful route naming works in Flask and why it is helpful.

Consider how different HTTP methods map to actions like create, read, update, and delete.

Practice

1. Which of the following is the best practice for naming a Flask route for a user profile page?

easy

A. /user-profile

B. /UserProfile

C. /user_profile

D. /User-Profile

Solution

1. Step 1: Understand Flask route naming conventions

   Flask routes should be lowercase and use hyphens to separate words for readability and consistency.

2. Step 2: Evaluate each option

   /user-profile uses lowercase letters and hyphens, which is the recommended style. Options B and D use uppercase letters, which is not standard. /user_profile uses underscores, which is less preferred than hyphens in URLs.

3. Final Answer:

   /user-profile -> Option A

4. Quick Check:

   Lowercase + hyphens = /user-profile [OK]

Hint: Use lowercase and hyphens for route names [OK]

Common Mistakes:

• Using uppercase letters in route names
• Using underscores instead of hyphens
• Mixing uppercase and lowercase inconsistently

2. Which of the following Flask route definitions is syntactically correct for a dynamic user ID?

easy

A. @app.route('/user/')

B. @app.route('/user/{id}')

C. @app.route('/user/:id')

D. @app.route('/user/')

Solution

1. Step 1: Recall Flask dynamic route syntax

   Flask uses angle brackets with optional type converters like <int:id> to define dynamic parts.

2. Step 2: Check each option's syntax

   @app.route('/user/') correctly uses <int:id>. @app.route('/user/{id}') uses curly braces which is invalid in Flask. @app.route('/user/:id') uses colon syntax from other frameworks, not Flask. @app.route('/user/') reverses type and variable name, which is incorrect.

3. Final Answer:

   @app.route('/user/<int:id>') -> Option A

4. Quick Check:

   Flask dynamic route = <type:variable> [OK]

Hint: Use syntax for dynamic integer routes [OK]

Common Mistakes:

• Using curly braces instead of angle brackets
• Reversing type and variable name order
• Using colon syntax from other frameworks

3. What will be the output when accessing the route /product/42 given this Flask code?

@app.route('/product/')
def show_product(product_id):
    return f"Product ID: {product_id}"

medium

A. TypeError

B. Product ID: 42

C. 404 Not Found

D. Product ID: product_id

Solution

1. Step 1: Understand route matching and parameter passing

   The route /product/<int:product_id> captures the integer 42 and passes it as product_id to the function.

2. Step 2: Evaluate the function return

   The function returns a string with the product ID inserted, so it returns "Product ID: 42".

3. Final Answer:

   Product ID: 42 -> Option B

4. Quick Check:

   Dynamic route passes 42 correctly [OK]

Hint: Dynamic routes pass variables to functions as parameters [OK]

Common Mistakes:

• Expecting the variable name as string output
• Confusing 404 error with route syntax
• Assuming type errors without cause

4. Identify the error in this Flask route definition:

@app.route('/order/')
def order(order_id):
    return f"Order {order_id}"

Which fix is correct?

medium

A. Change order_id to orderid in route and function

B. Remove int: and use <order_id> only

C. No fix needed; the code is correct

D. Add a trailing slash to the route like /order/<int:order_id>/

Solution

1. Step 1: Check route and function parameter consistency

   The route uses <int:order_id> and the function parameter is order_id, which matches correctly.

2. Step 2: Verify Flask route syntax and behavior

   The syntax is valid, and Flask accepts routes with or without trailing slashes. No error exists here.

3. Final Answer:

   No fix needed; the code is correct -> Option C

4. Quick Check:

   Matching names and valid syntax = correct code [OK]

Hint: Matching route variables and function params means no fix needed [OK]

Common Mistakes:

• Changing variable names unnecessarily
• Removing type converters without reason
• Thinking trailing slash is mandatory

5. You want to create a Flask route for blog posts with a slug (text) identifier. Which route name follows best practices and correctly captures the slug as a string?

hard

A. @app.route('/blogPost/<slug>')

B. @app.route('/blog_post/')

C. @app.route('/blog-post/<slug>')

D. @app.route('/blog-post/')

Solution

1. Step 1: Identify route naming conventions

   Use lowercase letters and hyphens for route names, so /blog-post/ is preferred over underscores or camelCase.

2. Step 2: Check dynamic segment syntax

   Flask uses <string:slug> to specify a string variable. @app.route('/blog-post/') uses both correct route naming and dynamic segment syntax.

3. Final Answer:

   @app.route('/blog-post/<string:slug>') -> Option D

4. Quick Check:

   Lowercase + hyphen + <string:var> = best practice [OK]

Hint: Use lowercase hyphens and for text routes [OK]

Common Mistakes:

• Using underscores or camelCase in route names
• Omitting type in dynamic segments
• Mixing naming styles inconsistently