Flask 项目结构分享

你好🐒!我作为副项目开发Flask应用程序已有5年了。这些年来,我终于搞清楚了Flask 项目的正确结构。

序言

首先,我们使用virtualenv隔离我的项目。例如,我们要开发一个轮询应用(a poll app)。

mkdir poll_app

cd poll_app

virtualenv .

source bin/activate

常用 Python 库

我正在开发需要数据库的应用程序。因此,我总是使用 flask_scriptflask_migrate 库。我不喜欢Flask的CLI工具。

和 Django 类似地,我在根文件夹中创建了一个名为 manage.py 的 Python 文件,例如:

from MYAPP.data.models import db
from MYAPP import app
from flask_script import Manager
from flask_migrate import Migrate, MigrateCommand

db.init_app(app)
migrate = Migrate(app, db)
manager = Manager(app)

manager.add_command('db', MigrateCommand)

if __name__ == "__main__":
    manager.run()

然后,我们可以对数据可进行如下操作:

python manage.py db init # --> init migrations

python manage.py db migrate # --> migrate models

python manage.py db upgrade # --> apply changes

python manage.py db --help # --> :)

主要应用文件

创建新项目时,我在根文件夹中创建了一个文件 app.py,然后它会像这样更改。

from MYAPP import app

# To do: This place will change later
config = {
    "development": "config.Development"
}

if __name__ == "__main__":
    app.config.from_object(config["development"])
    app.run()

配置文件

我还在根文件夹中创建了一个名为 config.py 的配置文件。

class BaseConfig(object):
    """ Base config class. This fields will use by production and development server """

    ORIGINS = ["*"] # for api calls
    SECRET_KEY = 'YOUR SECRET KEY'

class Development(BaseConfig):
    """ Development config. We use Debug mode """

    PORT = 5000
    DEBUG = True
    TESTING = False
    ENV = 'dev'

# Currently we only have development config.
# If you have production, you will need to pass it to here.
config = {
    'development': 'config.Development'
}

def configure_app(app):
    """ 
        App configuration will be here. 

        Parameters
        ----------

        app : Flask
            app instance
    """

    app.config.from_object(config['development'])

文件夹结构

我在根目录中创建一个文件夹,并将其命名为  om_core ,然后在奇中创建两个新的文件夹 api 和 data.。

api 文件储应用程序逻辑和路由。例如,我在 api 中创建了一个名为 user 的文件夹。

user 文件夹生成两个名为 init.pycontrollers.py 的文件,我们其他的 Api 层也会这样。controllers.py (控制器文件)应该像这样:

from flask import Blueprint, jsonify, request

from MYAPP.data.models import db, User

user = Blueprint('user', __name__)

@user.route('/', methods=['GET'])
def get_users():

    return jsonify({ "message": "Hi user :)"})

@user.route('/<int:id>', methods=['GET'])
def users(id):

    return jsonify({ "id": id })

我总是会使用蓝图。

data 文件夹存储一些模型。例如,我创建了一个名为 models.py 的文件:

from flask_sqlalchemy import SQLAlchemy
from MYAPP import app

# We didn't pass app instance here.
db = SQLAlchemy()

class User(db.Model):
    """ Model for user management """

    id = db.Column(db.Integer, primary_key=True)
    email = db.Column(db.String(100), unique=True)
    password = db.Column(db.String(100))
    name = db.Column(db.String(100))
    surname = db.Column(db.String(100))
    active = db.Column(db.Boolean(), default=True)
    created_at = db.Column(db.DateTime, default=db.func.now())
    updated_at = db.Column(db.DateTime, default=db.func.now())

    def __init__(self, email, password, name, surname, active, created_at, updated_at):
        self.email = email
        self.password = password
        self.name = name
        self.surname = surname
        self.active = active
        self.created_at = created_at
        self.updated_at = updated_at

让我们回到 om_core 文件夹。我创建了一个名为 init .py 的文件以将 Api 层用作端点。

from flask import Flask
from flask_cors import CORS

from config import BaseConfig
from config import configure_app

app = Flask(__name__)

from MYAPP.api.user.controllers import user

""" Corst settings will be here. We maybe use this endpoint later. """
cors = CORS(app, resources={
    r'/api/*': {
        'origins': BaseConfig.ORIGINS
    }
})

configure_app(app)

app.url_map.strict_slashes = False

app.register_blueprint(user, url_prefix='/api/users')

在上述代码中,我已经使用了 Flask-CORS 来允许来自不同来源的请求。如果您不想允许来自不同来源的请求,则不需要使用。

整体项目结构的屏幕截图

截图如下:

整体项目结构的屏幕截图

完成,如果您后续想在GitHub上查看此项目:https://github.com/foss-dev/open-monitorin...

谢谢阅读。

本文中的所有译文仅用于学习和交流目的,转载请务必注明文章译者、出处、和本文链接
我们的翻译工作遵照 CC 协议,如果我们的工作有侵犯到您的权益,请及时联系我们。

原文地址:https://dev.to/aligoren/how-i-structure-...

译文地址:https://learnku.com/python/t/38740

本文为协同翻译文章,如您发现瑕疵请点击「改进」按钮提交优化建议
讨论数量: 0
(= ̄ω ̄=)··· 暂无内容!

讨论应以学习和精进为目的。请勿发布不友善或者负能量的内容,与人为善,比聪明更重要!