了解 Flask 项目结构-Python教程

资源魔 2020-07-19 19:06:37 34 0

序文

起首，咱们应用 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, MigrateCo妹妹and
db.init_app(app)
migrate = Migrate(app, db)
manager = Manager(app)
manager.add_co妹妹and('db', MigrateCo妹妹and)
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 来容许来自没有同起源的申请。假如您没有想容许来自没有同起源的申请，则没有需求应用。

全体名目构造的屏幕截图

截图以下：