是否可以将 Flask 中的"app factory"模式与 Click CLI 应用程序一起使用？

Question

想象一下，我有一个大型CLI应用程序，其中包含许多不同的命令(例如image magik)。

我想把这个应用程序组织成模块等等。所以，在某个地方会有一个主click.group：

#main.py file
@click.group()
def my_app():
pass
if __name__ == "__main__":
my_app()

可以在定义命令的每个模块中导入：

from main import my_app
# command_x.py
@my_app.command() 
def command_x():
pass

问题是我遇到了一个循环导入问题，因为main.py文件对command_x.py一无所知，我必须在调用主要部分之前导入它。

这种情况也发生在Flask，通常是应用程序工厂模式处理的。通常你会在视图之前创建应用程序：

app = Flask("my_app")
@my_app.route("/")
def view_x():
pass
if __name__ == "__main__":
app.run()

在应用程序工厂模式中，您推迟蓝图的"注册"：

# blueprints.py
blueprint = Blueprint(yaddayadda)
@blueprint.route("/")
def view_x():
pass

制造一家知道如何构建应用程序并注册蓝图的工厂：

#app_factory.py
from blueprints import view_x
def create_app():
app = Flask()
view_x.init_app(app)
return app

然后你可以创建一个脚本来运行应用程序：

#main.py
from app_factory import create_app
if __name__ == "__main__":
app = create_app()
app.run()

类似的模式可以与Click一起使用吗？我可以创建一个"点击应用程序"(可能扩展click.Group)，在其中注册作为单独命令的"控制器"吗？

Answer 1

也许晚了，但我也在寻找将命令放入单独模块的解决方案。只需使用装饰器从模块中注入命令：

#main.py file
import click
import commands
def lazyloader(f):
# f is an instance of click.Group
f.add_command(commands.my_command)
return f
@lazyloader
@click.group()
def my_app():
pass
if __name__ == "__main__":
my_app()

分隔的命令可以通过单击使用常用的装饰器。

#commands.py
import click
@click.command()
def my_command():
pass

Answer 2

好的，所以我想了一点，似乎下面的可以工作。这可能不是一个最终的解决方案，但它似乎是一个初步的步骤。

我可以扩展MultiCommand类：

# my_click_classes.py
import click
class ClickApp(click.MultiCommand):
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
self.commands = {}
def add_command(self, command_name, command):
self.commands.update({command_name: command})
def list_commands(self, ctx):
return [name for name, _ in self.commands.items()]
def get_command(self, ctx, name):
return self.commands.get(name)

命令类：

class MyCommand(click.Command):
def init_app(self, app):
return app.add_command(self.name, self)
def mycommand(*args, **kwargs):
return click.command(cls=MyCommand)

这允许您在单独的模块中定义命令：

# commands.py
from my_click_classes import command
@command
def run():
print("run!!!")
@command
def walk():
print("walk...")

和一个单独模块中的"应用程序"：

from my_click_classes import ClickApp
from commands import run, walk
app = ClickApp()
run.init_app(app)
walk.init_app(app)
if __name__ == '__main__':
app()

或者甚至使用"应用工厂"模式。

不过，这可能不是一个最终的解决方案。如果你们能找到任何改进的方法，请告诉我。