flask 项目结构分享 | python优质外文翻译 | python 技术论坛-金年会app官方网
你好🐒！我作为副项目开发flask应用程序已有5年了。这些年来，我终于搞清楚了flask 项目的正确结构。
序言
首先，我们使用virtualenv隔离我的项目。例如，我们要开发一个轮询应用（a poll app）。
mkdir poll_app
cd poll_app
virtualenv .
source bin/activate
常用 python 库
我正在开发需要数据库的应用程序。因此，我总是使用 flask_script 和 flask_migrate 库。我不喜欢flask的cli工具。
- flask-script:
- flask-migrate:
和 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('/', 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')
在上述代码中，我已经使用了 来允许来自不同来源的请求。如果您不想允许来自不同来源的请求，则不需要使用。
整体项目结构的屏幕截图
截图如下：
完成，如果您后续想在github上查看此项目：
谢谢阅读。
本文中的所有译文仅用于学习和交流目的，转载请务必注明文章译者、出处、和本文链接
我们的翻译工作遵照 cc 协议，如果我们的工作有侵犯到您的权益，请及时联系金年会app官方网。
原文地址：
