Python Blueprint 项目教程

Python Blueprint 项目教程

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

python-blueprint/
├── .github/
│   └── workflows/
│       └── ci.yml
├── src/
│   ├── app/
│   │   ├── __init__.py
│   │   ├── main.py
│   │   ├── config.py
│   │   ├── routes.py
│   │   └── templates/
│   │       └── index.html
│   └── tests/
│       ├── __init__.py
│       └── test_main.py
├── .gitignore
├── LICENSE
├── README.md
├── requirements.txt
└── setup.py

目录结构介绍

• .github/workflows/ci.yml: GitHub Actions 的持续集成配置文件。
• src/app/: 应用程序的主要代码目录。
  • init.py: 初始化文件，用于定义包。
  • main.py: 项目的启动文件。
  • config.py: 项目的配置文件。
  • routes.py: 定义路由的文件。
  • templates/: 存放模板文件的目录。
    • index.html: 主页模板文件。
• src/tests/: 测试代码目录。
  • init.py: 初始化文件，用于定义包。
  • test_main.py: 测试 main.py 的测试文件。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文档。
• requirements.txt: 项目依赖文件。
• setup.py: 项目安装脚本。

2. 项目的启动文件介绍

main.py

from flask import Flask
from app.config import Config
from app.routes import main_bp

def create_app():
    app = Flask(__name__)
    app.config.from_object(Config)
    app.register_blueprint(main_bp)
    return app

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

启动文件介绍

• create_app(): 创建 Flask 应用实例的工厂函数。
  • 初始化 Flask 应用。
  • 从 config.py 加载配置。
  • 注册蓝图 main_bp。
• if name == "main":: 当文件作为主程序运行时，创建应用实例并启动开发服务器。

3. 项目的配置文件介绍

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:///site.db'
    SQLALCHEMY_TRACK_MODIFICATIONS = False

配置文件介绍

• Config 类: 包含应用的配置参数。
  • SECRET_KEY: 安全密钥，用于会话加密。
  • SQLALCHEMY_DATABASE_URI: 数据库连接 URI。
  • SQLALCHEMY_TRACK_MODIFICATIONS: 是否跟踪对象的修改。

以上是 Python Blueprint 项目的目录结构、启动文件和配置文件的详细介绍。希望这份文档能帮助你更好地理解和使用该项目。