Namespace concept in Flask - Interactive Code Practice

Practice - 5 Tasks

1fill in blank

easy

Complete the code to create a Flask Blueprint named 'admin'.

Flask

from flask import Blueprint
admin_bp = Blueprint('[1]', __name__)

Drag options to blanks, or click blank then click option'

Auser

Badmin

Cmain

Dapi

Attempts:

3 left

💡 Hint

Common Mistakes

Using a different name that doesn't match the namespace purpose.

The Blueprint name 'admin' is used to create a namespace for admin routes.

2fill in blank

medium

Complete the code to register the 'admin' Blueprint with the Flask app under the URL prefix '/admin'.

Flask

from flask import Flask
app = Flask(__name__)
app.register_blueprint(admin_bp, url_prefix='[1]')

Drag options to blanks, or click blank then click option'

A/api

B/user

C/main

D/admin

Attempts:

3 left

💡 Hint

Common Mistakes

Omitting the slash or using a wrong prefix.

The URL prefix '/admin' ensures all routes in the admin Blueprint start with '/admin'.

3fill in blank

hard

Fix the error in the route decorator to use the 'admin' Blueprint instead of the Flask app.

Flask

@[1].route('/dashboard')
def dashboard():
    return 'Admin Dashboard'

Drag options to blanks, or click blank then click option'

Aadmin_bp

Bblueprint

Cflask

Dapp

Attempts:

3 left

💡 Hint

Common Mistakes

Using 'app.route' instead of 'admin_bp.route'.

The route decorator must be called on the Blueprint object 'admin_bp' to register the route under that namespace.

4fill in blank

hard

Fill both blanks to create a Blueprint named 'api' and register it with the app under '/api'.

Flask

api_bp = Blueprint('[1]', __name__)
app.register_blueprint([2], url_prefix='/api')

Drag options to blanks, or click blank then click option'

Aapi

Badmin_bp

Capi_bp

Dmain

Attempts:

3 left

💡 Hint

Common Mistakes

Mixing up the Blueprint name and variable.

The Blueprint is named 'api' and the variable 'api_bp' is registered with the app.

5fill in blank

hard

Fill all three blanks to define a route '/status' in the 'api' Blueprint that returns JSON with a status message.

Flask

from flask import jsonify

@[1].route('[2]')
def status():
    return jsonify({{'status': '[3]'}})

Drag options to blanks, or click blank then click option'

Aapi_bp

B/status

Cok

Dadmin_bp

Attempts:

3 left

💡 Hint

Common Mistakes

Using the wrong Blueprint or incorrect route path.

The route is defined on 'api_bp' with path '/status' and returns JSON with status 'ok'.

Practice

1. What is the main purpose of using a Namespace in a Flask RESTX application?

easy

A. To group related API routes for better organization

B. To create a new Flask app instance

C. To handle database connections automatically

D. To style the API responses with CSS

Solution

1. Step 1: Understand what Namespace does

   A Namespace groups related routes together in Flask RESTX, making the API easier to manage.

2. Step 2: Compare options to Namespace purpose

   Only grouping routes matches the Namespace concept; others are unrelated to route grouping.

3. Final Answer:

   To group related API routes for better organization -> Option A

4. Quick Check:

   Namespace groups routes = A [OK]

Hint: Namespaces group routes logically in Flask RESTX [OK]

Common Mistakes:

• Thinking Namespace creates a new app
• Confusing Namespace with database handling
• Assuming Namespace affects styling

2. Which of the following is the correct way to create a Namespace named 'users' in Flask RESTX?

easy

A. users_ns = Namespace('users')

B. users_ns = Namespace(users)

C. users_ns = Namespace('Users')

D. users_ns = Namespace()

Solution

1. Step 1: Check Namespace constructor syntax

   The Namespace constructor requires a string name, so 'users' must be in quotes.

2. Step 2: Validate each option

   users_ns = Namespace('users') uses correct syntax with quotes and lowercase 'users'. users_ns = Namespace(users) misses quotes, causing error. users_ns = Namespace('Users') uses uppercase which is allowed but inconsistent naming. users_ns = Namespace() misses the name argument.

3. Final Answer:

   users_ns = Namespace('users') -> Option A

4. Quick Check:

   Namespace needs string name in quotes = B [OK]

Hint: Namespace name must be a string in quotes [OK]

Common Mistakes:

• Omitting quotes around the namespace name
• Using variable without quotes
• Not passing any argument to Namespace

3. Given the code snippet:

from flask_restx import Api, Namespace, Resource

api = Api()
users_ns = Namespace('users')

@users_ns.route('/profile')
class UserProfile(Resource):
    def get(self):
        return {'user': 'Alice'}

api.add_namespace(users_ns)

What URL path will return the JSON {'user': 'Alice'} when the Flask app runs?

medium

A. /api/users/profile

B. /profile

C. /users/profile

D. /users

Solution

1. Step 1: Understand Namespace route prefix

   The Namespace 'users' prefixes all routes inside it with '/users'. The route defined is '/profile'.

2. Step 2: Combine Namespace and route paths

   Combining '/users' and '/profile' gives '/users/profile' as the full URL path.

3. Final Answer:

   /users/profile -> Option C

4. Quick Check:

   Namespace prefix + route = /users/profile [OK]

Hint: Namespace name prefixes all its routes [OK]

Common Mistakes:

• Using route path without namespace prefix
• Assuming '/api' prefix automatically added
• Confusing route path with namespace name

4. Consider this code snippet:

from flask_restx import Api, Namespace, Resource

api = Api()
products_ns = Namespace('products')

@products_ns.route('/list')
class ProductList(Resource):
    def get(self):
        return {'items': ['apple', 'banana']}

# Missing line here

# Flask app run code omitted

What is the error and how to fix it?

medium

A. Return statement invalid; fix by returning a string instead of dict

B. Namespace not added to API; fix by calling api.add_namespace(products_ns)

C. Resource class missing __init__; fix by adding constructor

D. Route decorator syntax is wrong; fix by changing @products_ns.route to @api.route

Solution

1. Step 1: Identify missing integration step

   The Namespace 'products_ns' is defined but not added to the Api instance, so routes won't be registered.

2. Step 2: Fix by adding Namespace to Api

   Call api.add_namespace(products_ns) to register the namespace and its routes properly.

3. Final Answer:

   Namespace not added to API; fix by calling api.add_namespace(products_ns) -> Option B

4. Quick Check:

   Namespace must be added to API = D [OK]

Hint: Always add Namespace to Api with add_namespace() [OK]

Common Mistakes:

• Forgetting to add namespace to API
• Using wrong decorator for routes
• Thinking Resource needs constructor
• Returning wrong data type

5. You want to organize an API with two namespaces: 'users' and 'orders'. Each has a route '/list'. How do you ensure both routes work without conflict?

hard

A. Create namespaces with same name but different routes to avoid conflict

B. Use one namespace and define both routes '/users/list' and '/orders/list' inside it

C. Define routes without namespaces to avoid prefix conflicts

D. Create two namespaces named 'users' and 'orders', add both to API; routes become '/users/list' and '/orders/list'

Solution

1. Step 1: Understand namespace route prefixing

   Each Namespace prefixes its routes with its name, so 'users' namespace routes start with '/users', 'orders' with '/orders'.

2. Step 2: Use separate namespaces for separate route groups

   Creating two namespaces 'users' and 'orders' and adding both to API ensures '/users/list' and '/orders/list' are distinct and no conflict occurs.

3. Final Answer:

   Create two namespaces named 'users' and 'orders', add both to API; routes become '/users/list' and '/orders/list' -> Option D

4. Quick Check:

   Separate namespaces = separate route prefixes = C [OK]

Hint: Use separate namespaces for different route groups [OK]

Common Mistakes:

• Using one namespace for unrelated routes
• Creating namespaces with same name
• Avoiding namespaces and causing route conflicts