Flask コマンドライン API
Flask は Click に基づいてコマンドラインツールを構築しています。
によってflaskコマンドでアプリケーションと管理タスクを実行します。
すべての CLI クラスはflask.cliモジュール内にあります。
FlaskGroup
Flask のメインコマンドグループ。によってflaskコマンドで使用します。
| 引数 | 説明 |
|---|---|
| add_default_commands=True | run、shell、routes などのデフォルトコマンドを追加するかどうか |
| create_app=None | アプリケーションファクトリ関数。Flask インスタンスを返します。 |
| add_version_option=True | --version オプションを追加するかどうか |
| load_dotenv=True | .env と .flaskenv ファイルを読み込むかどうか |
| set_debug_flag=True | 環境変数に基づいて debug フラグを設定するかどうか |
AppGroup
アプリとブループリントの CLI コマンドグループの基底クラス。によってapp.cli 或 bp.cliカスタムコマンドを追加します。
| メソッド | 説明 |
|---|---|
| command(*args, **kwargs) | CLI コマンドを登録します。デフォルトで with_appcontext を自動的にラップします。 |
| group(*args, **kwargs) | サブコマンドグループを登録します。デフォルトでは AppGroup をグループクラスとして使用します。 |
AppGroup.command() はデフォルトで有効ですwith_appcontext=True、つまりコマンド関数は自動的にアプリコンテキストを保持します。不要な場合は、渡します。with_appcontext=False。
ScriptInfo
スクリプト実行時の情報を保存し、アプリケーションのロードに使用します。通常、手動による操作は必要ありません。
| 属性 | 説明 |
|---|---|
| app_import_path | アプリのインポートパス(--app オプション値) |
| create_app | アプリケーションファクトリ関数 |
| data | 任意の追加データ辞書 |
| load_app() | Flask アプリインスタンスをロードして返します。 |
ユーティリティ関数
| 関数 | 説明 |
|---|---|
| with_appcontext(f) | デコレータ。装飾された関数がアプリケーションコンテキスト内で実行されることを保証します。 |
| pass_script_info(f) | デコレータ。ScriptInfo インスタンスを関数の最初の引数として渡します。 |
| load_dotenv(path) | .env ファイル内の環境変数を読み込みます。 |
デフォルトコマンド
| コマンド | 説明 | 一般的な引数 |
|---|---|---|
| flask run | 開発サーバーを起動します。 | --host, --port, --debug, --reload/--no-reload |
| flask shell | インタラクティブな Python シェルを起動します。 | app、g などのコンテキスト変数を自動的に読み込みます。 |
| flask routes | 登録済みのすべてのルートを一覧表示します。 | --sort (endpoint/methods/domain/rule/match), --all-methods |
標準オプション
| オプション | 説明 |
|---|---|
| -A / --app IMPORT | アプリケーションモジュールとインスタンスを指定します。例: "app:create_app()" |
| --debug / --no-debug | デバッグモードを有効/無効にします。 |
| -e / --env-file FILE | .env ファイルのパスを指定します。 |
| --version | Flask と依存関係のバージョンを表示します。 |
コード例
例
from flask import Flask
app = Flask(__name__)
# カスタムコマンドを登録
@app.cli.command("init-db")
def init_db_command():
"""データベースを初期化"""
print("Database initialized.")
# 引数付きコマンドを登録
@app.cli.command("greet")
@app.cli.option("--name", "-n", default="サンプル", help="挨拶の対象")
def greet_command(name):
"""挨拶を送信"""
print(f"Hello, {name}!")
# サブコマンドグループを登録
user_cli = app.cli.group("user")
@user_cli.command("list")
def list_users():
"""すべてのユーザーを一覧表示"""
print("Listing users...")
@user_cli.command("create")
@user_cli.option("--username", required=True)
def create_user(username):
"""新しいユーザーを作成"""
print(f"Creating user: {username}")
# 使用方法:
# flask init-db
# flask greet --name World
# flask user list
# flask user create --username サンプル
app = Flask(__name__)
# カスタムコマンドを登録
@app.cli.command("init-db")
def init_db_command():
"""データベースを初期化"""
print("Database initialized.")
# 引数付きコマンドを登録
@app.cli.command("greet")
@app.cli.option("--name", "-n", default="サンプル", help="挨拶の対象")
def greet_command(name):
"""挨拶を送信"""
print(f"Hello, {name}!")
# サブコマンドグループを登録
user_cli = app.cli.group("user")
@user_cli.command("list")
def list_users():
"""すべてのユーザーを一覧表示"""
print("Listing users...")
@user_cli.command("create")
@user_cli.option("--username", required=True)
def create_user(username):
"""新しいユーザーを作成"""
print(f"Creating user: {username}")
# 使用方法:
# flask init-db
# flask greet --name World
# flask user list
# flask user create --username サンプル