Flask的項目結構介紹

序言

Flask是一個使用 Python 編寫的輕量級 Web 應用框架。其 WSGI 工具箱采用 Werkzeug ，模板引擎則使用 Jinja2 。Flask使用 BSD 授權。

Flask也被稱為 "microframework" ，因為它使用簡單的核心，用 extension 增加其他功能。Flask沒有默認使用的數據庫、窗體驗證工具。

首先，我們使用 virtualenv 隔離我的項目。例如，我們要開發一個輪詢應用（a poll app）。

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/

和 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.py 和 controllers.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 來允許來自不同來源的請求。如果您不想允許來自不同來源的請求，則不需要使用。

整體項目結構的屏幕截圖

截圖如下：

以上就是了解 Flask 項目結構的詳細內容，更多請關注億速云其它相關文章！