简道云V2.0

app/config.py

@@ -1,29 +1,59 @@
+"""
+应用配置模块
+
+本模块负责管理应用的所有配置项，包括：
+- 目录路径配置
+- API Token 配置
+- 日志配置
+
+注意：生产环境建议将敏感信息（如 API Token）移至环境变量。
+"""
 from pathlib import Path
 
 # 获取当前文件所在的目录
+# 当前文件位于 app/config.py，parent.parent 获取项目根目录
 BASE_DIR = Path(__file__).resolve().parent.parent  # 项目根目录
 
 # 构建保存下载文件的目录路径
+# 用于存储从简道云下载的文件
 SAVE_DIRECTORY = BASE_DIR / '下载文件'
 
 # 构建保存模板文件的目录路径
+# 用于存储模板文件
 MODE_DIRECTORY = BASE_DIR / '模板文件'
 
 # 构建日志文件的目录路径
+# 用于存储应用日志文件
 LOGS_DIRECTORY = BASE_DIR / 'logs'
 
+# 日志文件路径
 LOG_FILE = LOGS_DIRECTORY / '简道云.log'
 
 # 确保目录存在，如果不存在则创建
+# 在应用启动时自动创建必要的目录
 SAVE_DIRECTORY.mkdir(parents=True, exist_ok=True)
 MODE_DIRECTORY.mkdir(parents=True, exist_ok=True)
 
 # API 配置
+# 简道云 API Token，用于调用简道云 API
+# 注意：生产环境建议使用环境变量管理此配置
 JIANDAOYUN_API_TOKEN = 'Bearer qygHulymo1fekJk4CIZyNKjyQAzG8CFN'  # 曹伟应用api测试 app_key
 
 
-# 导出配置
 class Config:
+    """
+    应用配置类
+    
+    统一管理应用的所有配置项，方便在应用中使用。
+    
+    属性:
+        BASE_DIR: 项目根目录路径
+        SAVE_DIRECTORY: 下载文件保存目录
+        MODE_DIRECTORY: 模板文件保存目录
+        JIANDAOYUN_API_TOKEN: 简道云 API Token
+        LOGS_DIRECTORY: 日志文件目录
+        LOG_FILE: 日志文件路径
+    """
     BASE_DIR = BASE_DIR
     SAVE_DIRECTORY = SAVE_DIRECTORY
     MODE_DIRECTORY = MODE_DIRECTORY