Command pattern with Flask CLI - Mini Project: Build & Apply

Command pattern with Flask CLI

📖 Scenario: You are building a Flask web application that needs custom command-line commands to manage tasks like database setup and data seeding.Using Flask's CLI system, you will create commands that follow the command pattern, making your app easier to manage and extend.

🎯 Goal: Create a Flask CLI command using the command pattern that prints a welcome message.This will help you understand how to add custom commands to your Flask app.

📋 What You'll Learn

Create a Flask app instance

Define a command class following the command pattern

Register the command with Flask CLI

Run the command to print a message

💡 Why This Matters

🌍 Real World

Custom CLI commands help automate tasks like database setup, data import, or maintenance in Flask web apps.

💼 Career

Knowing how to add and organize CLI commands is valuable for backend developers working with Flask to improve app management and deployment.

1

Create the Flask app instance

Create a Flask app instance called app using Flask(__name__).

Flask

# Create the Flask app instance
# Your code here

Hint

Use app = Flask(__name__) to create the app instance.

2

Define a command class following the command pattern

Define a class called WelcomeCommand with a method run that prints the string "Welcome to Flask CLI!".

Flask

from flask import Flask

app = Flask(__name__)

# Define WelcomeCommand class with run method
# Your code here

Hint

Create a class with a run method that prints the welcome message.

3

Register the command with Flask CLI

Import with_appcontext from flask.cli. Then, create a function welcome that creates an instance of WelcomeCommand and calls its run method. Decorate this function with @app.cli.command("welcome") and @with_appcontext.

Flask

from flask import Flask

app = Flask(__name__)

class WelcomeCommand:
    def run(self):
        print("Welcome to Flask CLI!")

# Register the welcome command with Flask CLI
# Your code here

Hint

Use decorators @app.cli.command("welcome") and @with_appcontext on the function that runs the command.

4

Complete the Flask CLI command setup

Add the if __name__ == '__main__': block and call app.run() inside it to complete the Flask app setup.

Flask

from flask import Flask
from flask.cli import with_appcontext

app = Flask(__name__)

class WelcomeCommand:
    def run(self):
        print("Welcome to Flask CLI!")

@app.cli.command("welcome")
@with_appcontext
def welcome():
    cmd = WelcomeCommand()
    cmd.run()

# Add the main block to run the app
# Your code here

Hint

Add the standard Python main block to run the Flask app.

Practice

1. What is the main purpose of using the command pattern with Flask CLI?

easy

A. To create REST API endpoints

B. To organize CLI tasks as separate, reusable commands

C. To handle database migrations only

D. To automatically generate HTML pages

Solution

1. Step 1: Understand the command pattern concept

   The command pattern helps organize code by encapsulating tasks as commands that can be run independently.

2. Step 2: Relate to Flask CLI usage

   Flask CLI uses this pattern to let developers define separate commands for different tasks, making CLI management easier.

3. Final Answer:

   To organize CLI tasks as separate, reusable commands -> Option B

4. Quick Check:

   Command pattern = organize CLI tasks [OK]

Hint: Commands separate tasks for easy CLI use [OK]

Common Mistakes:

• Confusing CLI commands with web routes
• Thinking commands auto-generate HTML
• Assuming commands only handle databases

2. Which decorator is used to define a custom command in Flask CLI?

easy

A. @app.cli.command

B. @click.command

C. @flask.cli.command

D. @app.route

Solution

1. Step 1: Identify Flask CLI command decorator

   Flask CLI uses the @app.cli.command decorator to register custom CLI commands.

2. Step 2: Differentiate from other decorators

   @app.route is for web routes, @click.command is from click but not directly used on Flask app, and @flask.cli.command is incorrect syntax.

3. Final Answer:

   @app.cli.command -> Option A

4. Quick Check:

   Flask CLI command decorator = @app.cli.command [OK]

Hint: Use @app.cli.command to add CLI commands [OK]

Common Mistakes:

• Using @app.route for CLI commands
• Confusing @click.command with Flask app decorator
• Typing @flask.cli.command which is invalid

3. Given this Flask CLI command code, what will be printed when running flask greet?

import click
from flask import Flask
app = Flask(__name__)

@app.cli.command()
@click.argument('name')
def greet(name):
    click.echo(f'Hello, {name}!')

medium

A. Hello, name!

B. Hello, <name>!

C. Hello, None!

D. Error: Missing argument 'name'

Solution

1. Step 1: Analyze the command definition

   The command greet requires a positional argument name due to @click.argument('name').

2. Step 2: Check the command usage

   Running flask greet without providing name will cause Click to raise an error about the missing argument.

3. Final Answer:

   Error: Missing argument 'name' -> Option D

4. Quick Check:

   Missing required argument causes error [OK]

Hint: Provide all required arguments to avoid errors [OK]

Common Mistakes:

• Assuming default values for arguments
• Expecting 'name' to print literally
• Ignoring Click argument requirements

4. Identify the error in this Flask CLI command code:

from flask import Flask
app = Flask(__name__)

@app.cli.command()
def hello():
    print('Hello from CLI')

if __name__ == '__main__':
    app.run()

medium

A. Missing @click.argument decorator

B. Using print instead of click.echo

C. Running app.run() in CLI command file

D. No error, code is correct

Solution

1. Step 1: Review the purpose of app.run()

   app.run() starts the Flask web server and is not needed or appropriate in CLI command files.

2. Step 2: Understand CLI command usage

   Flask CLI commands run via flask command, so running app.run() here will start the server unnecessarily and block CLI commands.

3. Final Answer:

   Running app.run() in CLI command file -> Option C

4. Quick Check:

   app.run() should not be in CLI command files [OK]

Hint: Don't call app.run() in CLI command scripts [OK]

Common Mistakes:

• Thinking print is wrong (it's allowed but click.echo preferred)
• Assuming @click.argument is always required
• Not separating web server run from CLI commands

5. You want to create a Flask CLI command that prints all user names from a database. Which approach correctly uses the command pattern with app context?

hard

A. Use @app.cli.command and inside the function, query users within a with app.app_context() block

B. Use @app.route to define the command and query users directly

C. Define a function without decorators and call it from main

D. Use @click.command without app context and query users

Solution

1. Step 1: Understand Flask CLI command with app context

   Commands need Flask app context to access database and app features, so use with app.app_context() inside the command function.

2. Step 2: Evaluate options

   @app.route is for web routes, not CLI commands. Calling functions without decorators won't register CLI commands. Using @click.command alone lacks app context, causing errors.

3. Final Answer:

   Use @app.cli.command and inside the function, query users within a with app.app_context() block -> Option A

4. Quick Check:

   CLI commands need app context for DB access [OK]

Hint: Wrap DB queries in app.app_context() inside CLI commands [OK]

Common Mistakes:

• Using @app.route for CLI commands
• Forgetting app context for DB access
• Not registering commands with decorators