Command pattern with Flask CLI - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the Command pattern in the context of Flask CLI?

The Command pattern organizes code into separate commands that can be run from the command line using Flask CLI. Each command is a small, focused task you can run easily.

beginner

How do you create a custom command in Flask CLI?

You create a function decorated with @app.cli.command(). This function runs when you type the command name in the terminal.

intermediate

Why use the Command pattern with Flask CLI?

It helps keep your code clean by separating tasks like database setup, testing, or data import into easy-to-run commands.

intermediate

What decorator is used to add arguments to a Flask CLI command?

You use @click.argument or @click.option decorators to add arguments or options to your command functions.

beginner

How does Flask CLI find and run your custom commands?

Flask CLI looks for functions decorated with @app.cli.command() in your app code and makes them available as commands you can run in the terminal.

Which decorator do you use to create a new Flask CLI command?

A @app.cli.command()

B @app.route()

C @click.command()

D @flask.command()

Use @app.cli.command() to define a new CLI command in Flask.

What Python package does Flask CLI use under the hood for command line parsing?

A argparse

B click

C optparse

D sys

Flask CLI uses the 'click' package to handle command line arguments and options.

How do you add an argument to a Flask CLI command?

A Using @click.argument()

B Using @app.argument()

C Using @app.cli.argument()

D Using @flask.argument()

Arguments are added with the @click.argument() decorator.

What is the main benefit of using the Command pattern with Flask CLI?

A To style HTML templates

B To create web routes

C To organize command line tasks cleanly

D To manage database migrations automatically

The Command pattern helps organize command line tasks into clear, reusable commands.

Which command runs your Flask CLI commands?

A python flask.py

B flask run

C python manage.py

D flask <command-name>

You run custom commands with 'flask ' in the terminal.

Explain how to create and run a custom command using Flask CLI.

Think about how Flask CLI connects your Python function to a terminal command.

Describe the advantages of using the Command pattern in Flask CLI for your projects.

Consider how breaking tasks into commands helps in real-life project work.

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