序言

Flask是一个使用 Python 编写的轻量级 Web 应用框架。其 WSGI 工具箱采用 Werkzeug ,模板引擎则使用 Jinja2 。Flask使用 BSD 授权。

Flask也被称为 "microframework" ,因为它使用简单的核心,用 extension 增加其他功能。Flask没有默认使用的数据库、窗体验证工具。

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

mkdir poll_appcd poll_appvirtualenv .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 dbfrom MYAPP import appfrom flask_script import Managerfrom flask_migrate import Migrate, MigrateCommanddb.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 migrationspython manage.py db migrate # --> migrate modelspython manage.py db upgrade # --> apply changespython manage.py db --help # --> :)

主要应用文件

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

from MYAPP import app# To do: This place will change laterconfig = { "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, requestfrom MYAPP.data.models import db, Useruser = 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 SQLAlchemyfrom 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 Flaskfrom flask_cors import CORSfrom config import BaseConfigfrom config import configure_appapp = 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 = Falseapp.register_blueprint(user, url_prefix='/api/users')

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

整体项目结构的屏幕截图

截图如下:

以上就是了解 Flask 项目结构的详细内容,更多请关注亿速云其它相关文章!