Yearning 开源项目教程

1. 项目目录结构及介绍

Yearning 的目录结构是标准的 Python web 应用架构，主要目录和文件如下：

├── config        # 配置文件夹
│   ├── config.py  # 主配置文件
├── app           # 应用代码文件夹
│   ├── __init__.py
│   └── ...
├── static        # 静态资源文件夹
└── templates     # 模板文件夹
    └── ...

• config: 存放应用的各种配置项，包括数据库连接等。
• app: 项目的核心代码，包括业务逻辑和路由定义等。
• static: 存放 CSS、JavaScript 和其他静态资源文件。
• templates: 存放 Flask 模板文件，用于构建动态网页。

2. 项目启动文件介绍

Yearning 的启动文件通常是 app/__init__.py 或者单独的 run.py 文件。此文件包含了初始化 Flask 应用、加载配置、注册蓝本以及设置路由等操作。一个典型的启动文件可能会有如下关键部分：

from flask import Flask
from config import Config

app = Flask(__name__)
app.config.from_object(Config)

from app import routes, models  # 导入路由和模型

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

这里 Config 是从 config/config.py 导入的配置类，routes 和 models 分别导入了应用的路由模块和数据模型模块，使得它们可以在主程序中使用。

3. 项目配置文件介绍

config.py 是 Yearning 项目的主要配置文件，它通常包含以下几大类配置：

class Config:
    SECRET_KEY = 'your_secret_key'         # 可以随机生成的安全密钥
    MYSQL_USER = 'db_username'            # 数据库用户名
    MYSQL_ADDR = 'localhost'              # 数据库地址
    MYSQL_PASSWORD = 'db_password'        # 数据库密码
    MYSQL_DB = 'yearning_db'             # 数据库存储的名称
    SQLALCHEMY_DATABASE_URI = f'mysql://{MYSQL_USER}:{MYSQL_PASSWORD}@{MYSQL_ADDR}/{MYSQL_DB}' 
    SQLALCHEMY_TRACK_MODIFICATIONS = False  # 禁止 SQLAlchemy 自动检测表的修改

这些配置变量用于初始化 Flask-SQLAlchemy 并连接到 MySQL 数据库。可以根据实际环境替换相应的值，例如 SECRET_KEY 应该用一个安全的字符串代替，而 MYSQL_USER, MYSQL_ADDR, MYSQL_PASSWORD, MYSQL_DB 则对应你的数据库访问凭证。SQLALCHEMY_DATABASE_URI 是整合以上信息后的完整数据库连接字符串。

在应用启动时，通过 app.config.from_object(Config) 将配置加载到 Flask 应用实例中，以便后续使用。记得在部署时确保敏感信息（如密码）的安全，可能需要考虑使用环境变量而不是直接写在代码中。

以上就是 Yearning 项目的目录结构、启动文件和配置文件的基本介绍。根据这个框架，你可以进一步学习和定制 Yearning 来满足自己的需求。