docs: 为全部代码补充中文注释并加入 AGENTS 注释规范

This commit is contained in:
cat-shark
2026-08-13 22:09:55 +08:00
parent 77e9ac6b7e
commit ac41a9a6da
29 changed files with 472 additions and 2 deletions
+10
View File
@@ -1,3 +1,9 @@
"""节点实例管理路由。
提供管理后台查看节点实例与手动停止实例的能力。实例生命周期仍由
NodeManager 控制,路由只转发停止请求。
"""
from __future__ import annotations
from fastapi import APIRouter, Depends, HTTPException
@@ -9,12 +15,14 @@ router = APIRouter(prefix="/api/admin/node-instances", tags=["node-instances"])
def _get_db() -> Database:
"""从应用状态延迟获取数据库实例。"""
from app.main import app
return app.state.db
def _get_manager() -> NodeManager:
"""从应用状态延迟获取节点管理器。"""
from app.main import app
return app.state.node_manager
@@ -22,6 +30,7 @@ def _get_manager() -> NodeManager:
@router.get("")
def list_instances(db: Database = Depends(_get_db)) -> list[dict]:
"""返回全部节点实例记录。"""
return db.list_instances()
@@ -31,6 +40,7 @@ def stop_instance(
db: Database = Depends(_get_db),
manager: NodeManager = Depends(_get_manager),
) -> dict:
"""请求停止指定实例;停止后实例记录保留为 stopped 状态。"""
manager.stop_instance(instance_id)
instance = next(
(item for item in db.list_instances() if item["id"] == instance_id),