Merge pull request #7050 from DDSRem-Dev/codex-comment-migration

docs: 统一全项目中文注释和结构化契约说明
This commit is contained in:
DDSRem
2026-10-17 19:26:29 +08:00
committed by GitHub
parent 3c7431b7da
commit 2de976f6b3
2345 changed files with 143990 additions and 61534 deletions

View File

@@ -1,3 +1,7 @@
"""
PostgreSQL 数据库的模块声明与连通性检查。
"""
from typing import Optional, Tuple
from app.application.database import get_database_governance
@@ -8,50 +12,60 @@ from app.schemas.types import ModuleType, OtherModulesType
class PostgreSQLModule(_ModuleBase):
"""
PostgreSQL 数据库模块
PostgreSQL 数据库模块。
"""
def init_module(self) -> None:
"""PostgreSQL 连接由数据库 adapter 管理,无需模块级初始化。"""
"""
PostgreSQL 连接由数据库适配器 管理,无需模块级初始化。
"""
pass
@staticmethod
def get_name() -> str:
"""返回模块展示名称。"""
"""
返回模块展示名称。
"""
return "PostgreSQL"
@staticmethod
def get_type() -> ModuleType:
"""
获取模块类型
获取模块类型。
"""
return ModuleType.Other
@staticmethod
def get_subtype() -> OtherModulesType:
"""
获取模块子类型
获取模块子类型。
"""
return OtherModulesType.PostgreSQL
@staticmethod
def get_priority() -> int:
"""
获取模块优先级,数字越小优先级越高,只有同一接口下优先级才生效
获取模块优先级,数字越小优先级越高,只有同一接口下优先级才生效。
"""
return 0
def init_setting(self) -> None:
"""数据库类型由部署配置决定,不声明独立模块开关。"""
"""
数据库类型由部署配置决定,不声明独立模块开关。
"""
pass
def stop(self) -> None:
"""连接池由数据库生命周期释放,本模块无独立资源。"""
"""
连接池由数据库生命周期释放,本模块无独立资源。
"""
pass
def test(self) -> Optional[Tuple[bool, str]]:
"""
测试模块连接性
检查部署配置选中的 PostgreSQL 数据库。
:return: 连接结果和错误说明;部署未使用 PostgreSQL 时返回 None
"""
if get_runtime_setting('DB_TYPE') != "postgresql":
return None