如何获取Flask执行的CLI命令？实现特定命令下触发函数

其实要搞定这两个需求——知道当前运行的Flask CLI命令、只在flask run时启动你的Process——核心是利用Flask CLI底层基于Click这个库的特性，下面一步步给你说：

一、如何获知当前执行的CLI命令 #

Flask的所有CLI命令都是基于Click实现的，所以我们可以通过Click的上下文来拿到当前命令的信息：

1. 首先导入click库，然后在需要的地方调用click.get_current_context()获取当前命令的上下文对象。
2. 从上下文对象里的command.name属性就能直接拿到当前执行的命令名称，比如执行flask run时是'run'，执行flask initdb时就是'initdb'。

举个简单的例子，在你的应用代码里可以这么写：

import click

# 在需要检查命令的地方
try:
    ctx = click.get_current_context()
    current_command = ctx.command.name
    print(f"当前执行的CLI命令是：{current_command}")
except RuntimeError:
    # 非CLI方式启动应用时（比如用WSGI服务器），会抛出这个错误，直接忽略即可
    pass

二、仅在flask run时调用目标函数 #

针对你想在flask run --host=0.0.0.0启动时启动Process，而flask initdb时不执行的需求，有两种常用的实现方式：

方法1：在应用初始化时检查命令 #

如果你用的是类似flaskr的应用工厂模式，可以在创建应用的时候检查当前命令，只在run命令执行时启动Process：

from flask import Flask
import click
from multiprocessing import Process

def your_background_task():
    # 这里写你要在后台执行的逻辑
    print("后台任务已启动！")

def create_app():
    app = Flask(__name__)

    # 检查当前是否是CLI命令执行，且命令为run
    try:
        ctx = click.get_current_context()
        if ctx.command.name == 'run':
            # 启动你的进程
            p = Process(target=your_background_task)
            p.start()
    except RuntimeError:
        # 非CLI启动时（比如gunicorn），跳过这段逻辑
        pass

    # 这里继续添加你的应用配置、路由、注册蓝图等逻辑
    return app

这种方式的好处是不用修改原有的run命令逻辑，直接在应用初始化时做判断就行，非常简洁。

方法2：包装原run命令 #

如果你想更灵活地控制run命令的执行流程，可以直接包装Flask自带的run命令，在执行原命令前先启动你的Process：

from flask import Flask
import click
from multiprocessing import Process

app = Flask(__name__)

def your_background_task():
    print("后台任务已启动！")

# 获取Flask默认的run命令
original_run = app.cli.commands['run']

# 自定义新的run命令，先执行你的逻辑再调用原命令
@click.command(name='run', context_settings=original_run.context_settings)
@click.option('--host', default='127.0.0.1')
@click.option('--port', default=5000)
# 这里要包含原run命令的所有参数，或者用**kwargs来接收所有参数
def custom_run(**kwargs):
    # 先启动你的Process
    p = Process(target=your_background_task)
    p.start()
    # 再执行原run命令的逻辑
    original_run.main(**kwargs)

# 替换掉默认的run命令
app.cli.commands['run'] = custom_run

这种方式适合需要对run命令添加更多自定义逻辑的场景，比如额外的参数校验、前置操作等。

需要注意的是：如果你的应用是通过WSGI服务器（比如gunicorn、uWSGI）启动的，而不是用flask run，那么Click的上下文会不存在，上面的逻辑会自动跳过，不会启动Process，这也符合我们的预期。

内容的提问来源于stack exchange，提问作者user786904