Flask 项目目录结构

2024年1月20日 205次阅读 来源: Uchen

翻译原文：https://lepture.com/en/2018/structure-of-a-flask-project
原文作者：lepture， pallets 小组成员，flask 系列核心开发者

flask 非常灵活，它没有一个固定的项目目录组织结构。这里写的只是我的一些建议

Flask 非常灵活，它可以让有经验的开发人员按照他们自己喜欢来组织项目的目录结构。但是对于新手来说会感到困惑，他们在组织项目目录结构时需要一些指导，并且通常情况下他们会去找一些项目结构示例，但这些示例总不是那么好（甚至很糟糕）。

我并不知道还有这样的问题，直到有人在 Authlib 中提 issue。刚开始我还不能理解问题，后来有人以项目结构的方式向我解释，我终于明白了。

我吓坏了，因为很多文章，样板文件是从项目根 __init__.py 逆向导入模块的:

# project/__init__.py
from flask import Flask
from flask_sqlalchemy import SQLAlchemy

db = SQLAlchemy()

def create_app():
    app = Flask(__name__)
    db.init_app(app)

# project/auth/models.py
from .. import db
class User(db.Model):
    # define columns

代码本身是可以工作的，但当你项目变大时，你将面临一个循环依赖的问题。例如，另一个扩展需要与用户模型一起初始化:

# project/__init__.py
from flask_sqlalchemy import SQLAlchemy
from another_extension import AnotherExtension
from project.auth.models import User

db = SQLAlchemy()
ext = AnotherExtension(User)

糟糕，发生​依赖关系包循环导入问题。因为 auth.models 正在从项目根目录下导入 db，而根目录下不能导入 User module。这是一个常见的循环导入问题，不只限于 flask 。这个问题很容易解决，但是初级开发人员来说可能会很难。所以为什么不在开始的时候就避免它呢。事实上，如果你阅读了官方文档，你会在应用工厂中找到这段代码:

def create_app(config_filename):
    app = Flask(__name__)
    app.config.from_pyfile(config_filename)
    from yourapplication.model import db
    db.init_app(app)
    from yourapplication.views.admin import admin
    from yourapplication.views.frontend import frontend
    app.register_blueprint(admin)
    app.register_blueprint(frontend)
    return app

这里，我们把 db 放在 yourapplication.model 中。

我在编写模块和包时，总是保持这个特定的规则:

不要从根目录下的 __init__.py 中逆向导入

这就是在我发现这个问题之后尽我可能快的提交 ticket 到 Flask 的原因。人们在项目目录结构组织时需要一个指导。这里我分享下我的建议，但是还是要自己思考，不要把我当作金科玉律。

基于功能的结构

设置项目目录结构有很多种方式。一种是按它的功能来组织，例如:

project/
  __init__.py
  models/
    __init__.py
    base.py
    users.py
    posts.py
    ...
  routes/
    __init__.py
    home.py
    account.py
    dashboard.py
    ...
  templates/
    base.html
    post.html
    ...
  services/
    __init__.py
    google.py
    mail.py
    ...

一切都是按功能分组的。如果它的行为像模型，则将它放在 models 目录；如果它的行为像路由，则将它放入 routes 目录。在 project/__init__.py 中创建一个 create_app 工厂函数，并且初始化所有应用 init_app：

# project/__init__.py
from flask import Flask

def create_app()
    from . import models, routes, services
    app = Flask(__name__)
    models.init_app(app)
    routes.init_app(app)
    services.init_app(app)
    return app

这里是我的一个小技巧。在官方文档中，Flask-SQlAlchemy 的 db 是通过这个方式注册的：

from project.models import db
db.init_app(app)

所是我的技巧是在每个目录下的 __init__.py 中定义一个 init_app 函数，并且统一初始化进程:

# project/models/__init__.py
from .base import db

def init_app(app):
    db.init_app(app)

# project/routes/__init__.py
from .users import user_bp
from .posts import posts_bp
# ...

def init_app(app):
    app.register_blueprint(user_bp)
    app.register_blueprint(posts_bp)    

# ...

基于应用的结构

另一个著名的目录结构是基于应用的结构，这意味着按照业务项目的应用程序来分组。例如：

project/
  __init__.py
  db.py
  auth/
    __init__.py
    route.py
    models.py
    templates/
  blog/
    __init__.py
    route.py
    models.py
    templates/
...

每个目录都对应一个应用。Django 默认是使用这种方式来组织目录。当然这并不意味该方式是很好的，你需要按照项目来选择目录结构。某些时候，你将不得不使用一个混合模式。

类似于上面的，你可以像这样来 init_app :

# project/__init__.py
from flask import Flask

def create_app()
    from . import db, auth, blog
    app = Flask(__name__)
    db.init_app(app)
    auth.init_app(app)
    blog.init_app(app)
    return app

配置

加载配置将是另一个问题，我不知道其他人是怎么做的，我只是分享我的解决方案。

  1. 在项目目录下放一个 settings.py 文件，把它当作静态配置。
  2. 从环境变量中加载配置。
  3. 在 create_app 中更新配置。

这是一个配置的基础目录结构：

conf/
  dev_config.py
  test_config.py
project/
  __init__.py
  settings.py
app.py

定义一个 create_app 来加载配置和环境变量：

# project/__init__.py
import os
from flask import Flask

def create_app(config=None)
    app = Flask(__name__)
    # load default configuration
    app.config.from_object('project.settings')
    # load environment configuration
    if 'FLASK_CONF' in os.environ:
        app.config.from_envvar('FLASK_CONF')
    # load app sepcified configuration
    if config is not None:
        if isinstance(config, dict):
            app.config.update(config)
        elif config.endswith('.py'):
            app.config.from_pyfile(config)
    return app

FLASK_CONF 是一个包含配置的 python 文件（包含路径）。这可以是任何你想要的名称, 如项目叫做 Expanse，你可以叫它 Expanse_CONF。

我使用 FLASK_CONF 来加载生产环境的配置。

再一次说明，Flask 是非常灵活的，没有固定的模式。在 Flask 中你总是可以找到你所喜欢的。以上只是我的建议方案，不要被任何人蒙住眼睛。

我不喜欢写这样的文章。但有很多错误的指导，我希望这篇文章能得到更好的搜索引擎优化，这样不好的帖子就不会再误导人了。

    原文作者：Uchen
    原文地址: https://www.jianshu.com/p/49dc66141d20
    本文转自网络文章，转载此文章仅为分享知识，如有侵权，请联系博主进行删除。
点赞