如何构建我的 Flask 应用程序

问如何在视图中调用app.config['some conf']？

这篇文章之前发表在我的博客上

你好。我开发 Flask 应用已经五年了，这还是个业余项目。经过这么多年，我终于找到了适合自己的架构。

第一步

首先，我经常使用虚拟环境来隔离我的项目。比如，我们想开发一个投票应用。

mkdir poll_app

cd poll_app

virtualenv .

source bin/activate

我经常使用的 Python 库

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

Flask-Script： https: //flask-script.readthedocs.io/en/latest/
Flask-Migrate：https://flask-migrate.readthedocs.io/en/latest/

我在根文件夹中创建一个名为manage.py的python文件，类似于Django的。例如：

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。我在om_core中创建了两个文件夹。

它们的名称分别为api和data。api文件夹存储应用程序逻辑和路由。例如，我创建了一个名为user 的文件夹。

此文件夹包含两个文件，分别为init.py和controllers.py 。我们的其他 API 层将与此类似。控制器文件应如下所示：

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 })

我总是使用蓝图。

数据文件夹存储模型。例如，我创建了一个名为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-monitoring

谢谢阅读。

文章来源：https://dev.to/itachiuchiha/how-i-struct-my-flask-apps-3eh8

我如何构建我的 Flask 应用程序询问如何在视图中调用 app.config['some conf']？