tedivms-flask 项目教程-优快云博客

tedivms-flask 项目教程

tedivms-flask Flask starter app with celery, bootstrap, and docker environment 项目地址: https://gitcode.com/gh_mirrors/te/tedivms-flask

1. 项目的目录结构及介绍

tedivms-flask/
├── app/
│   ├── __init__.py
│   ├── models/
│   ├── routes/
│   ├── static/
│   └── templates/
├── config/
│   ├── __init__.py
│   ├── config.py
│   └── settings.py
├── migrations/
├── tests/
├── .env
├── .gitignore
├── README.md
├── requirements.txt
└── run.py

app/: 包含应用程序的主要代码。
- init.py: 初始化 Flask 应用程序。
- models/: 存放数据库模型。
- routes/: 存放路由处理函数。
- static/: 存放静态文件（如 CSS、JavaScript 文件）。
- templates/: 存放 HTML 模板文件。
config/: 包含应用程序的配置文件。
- init.py: 初始化配置模块。
- config.py: 主要的配置文件。
- settings.py: 可能包含一些额外的设置。
migrations/: 存放数据库迁移文件。
tests/: 存放测试代码。
.env: 存放环境变量。
.gitignore: 指定 Git 忽略的文件和目录。
README.md: 项目的说明文档。
requirements.txt: 列出项目依赖的 Python 包。
run.py: 项目的启动文件。

2. 项目的启动文件介绍

run.py 是项目的启动文件，用于启动 Flask 应用程序。以下是 run.py 的基本内容：

from app import create_app

app = create_app()

if __name__ == "__main__":
    app.run(debug=True)

from app import create_app: 从 app 模块导入 create_app 函数。
app = create_app(): 调用 create_app 函数创建 Flask 应用程序实例。
if name == "main": 确保只有在直接运行 run.py 时才会启动应用程序。
app.run(debug=True): 以调试模式启动应用程序。

3. 项目的配置文件介绍

config.py 是项目的主要配置文件，通常位于 config/ 目录下。以下是 config.py 的基本内容：

import os

class Config:
    SECRET_KEY = os.environ.get('SECRET_KEY') or 'you-will-never-guess'
    SQLALCHEMY_DATABASE_URI = os.environ.get('DATABASE_URL') or 'sqlite:///app.db'
    SQLALCHEMY_TRACK_MODIFICATIONS = False

class DevelopmentConfig(Config):
    DEBUG = True

class ProductionConfig(Config):
    DEBUG = False

config = {
    'development': DevelopmentConfig,
    'production': ProductionConfig,
    'default': DevelopmentConfig
}

Config: 基础配置类，包含通用的配置项。
- SECRET_KEY: 用于会话加密的密钥。
- SQLALCHEMY_DATABASE_URI: 数据库连接字符串。
- SQLALCHEMY_TRACK_MODIFICATIONS: 是否跟踪对象的修改。
DevelopmentConfig: 开发环境的配置类，继承自 Config，并设置 DEBUG = True。
ProductionConfig: 生产环境的配置类，继承自 Config，并设置 DEBUG = False。
config: 配置字典，用于根据环境选择不同的配置类。