Skip to content

Commit 88a88ff

Browse files
committed
refactor(mcsmapi): 根据文档重新校对代码并更新注释格式
- 更新了多个 API 类的参数类型和返回类型 - 优化了部分函数的实现逻辑 - 统一了参数命名和类型注解 - 调整了部分模型的属性名称
1 parent 6fef095 commit 88a88ff

File tree

15 files changed

+551
-568
lines changed

15 files changed

+551
-568
lines changed

example/user.py

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
print(user.userName)
1414

1515
# 查找第一个管理员账号
16-
user = api.user().search(role="10").data[0]
16+
user = api.user().search(role=10).data[0]
1717

1818
# 封禁管理员账号
1919
user.update({"permission": -1})
@@ -22,13 +22,9 @@
2222
user.delete()
2323

2424
# 创建新用户
25-
uuid = userManager.create("test", "54ABCd9bf#")
25+
uuid = userManager.create("test", "54ABCd9bf#").uuid
2626

2727
print("New user uuid:", uuid)
2828

2929
# 删除新用户
30-
if isinstance(uuid, str):
31-
userManager.delete([uuid])
32-
else:
33-
# 在比较旧的版本中,创建用户时不会返回uuid,需要手动查找
34-
userManager.search(username="test").data[0].delete()
30+
userManager.delete([uuid])

mcsmapi/apis/daemon.py

Lines changed: 21 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,7 @@ def show() -> list[DaemonConfig]:
1010
"""
1111
获取全部节点配置信息
1212
13-
返回:
14-
- List[DaemonConfig]: 节点的配置信息列表
13+
:returns: 节点的配置信息列表
1514
"""
1615
daemons = send(
1716
"GET",
@@ -24,8 +23,7 @@ def system() -> list[DaemonModel]:
2423
"""
2524
获取全部节点的系统信息
2625
27-
返回:
28-
- List[DaemonModel]: 节点系统信息列表
26+
:returns: 节点系统信息列表
2927
"""
3028
daemons = send(
3129
"GET",
@@ -36,64 +34,59 @@ def system() -> list[DaemonModel]:
3634
@staticmethod
3735
def add(config: dict[str, Any]) -> str:
3836
"""
39-
新增一个节点
37+
新增一个节点
4038
41-
参数:
42-
- config (dict): 节点的配置信息,以字典形式提供,缺失内容由DaemonConfig模型补全。
39+
:params config: 节点的配置信息,以字典形式提供,缺失内容由DaemonConfig模型补全
4340
44-
返回:
45-
- str: 新增节点的ID
41+
:returns: 新增节点的UUID
4642
"""
4743
return send(
4844
"POST",
4945
f"{ApiPool.SERVICE}/remote_service",
50-
data=DaemonConfig(**config).dict(),
46+
data=DaemonConfig(**config).model_dump(),
5147
)
48+
5249
@staticmethod
5350
def delete(daemonId: str) -> bool:
5451
"""
55-
删除一个节点
52+
删除一个节点
5653
57-
参数:
58-
- daemonId (str): 节点的唯一标识符。
54+
:params daemonId: 节点的UUID
5955
60-
返回:
61-
- bool: 删除成功后返回True
56+
:returns: 删除成功后返回True
6257
"""
6358
return send(
6459
"DELETE", f"{ApiPool.SERVICE}/remote_service", params={"uuid": daemonId}
6560
)
61+
6662
@staticmethod
6763
def link(daemonId: str) -> bool:
6864
"""
69-
连接一个节点
65+
连接一个节点
7066
71-
参数:
72-
- daemonId (str): 节点的唯一标识符。
67+
:params daemonId: 节点的UUID
7368
74-
返回:
75-
- bool: 连接成功后返回True
69+
:returns: 连接成功后返回True
7670
"""
7771
return send(
7872
"GET", f"{ApiPool.SERVICE}/link_remote_service", params={"uuid": daemonId}
7973
)
74+
8075
@staticmethod
8176
def update(daemonId: str, config: dict[str, Any]) -> bool:
8277
"""
83-
更新一个节点的配置
78+
更新一个节点的配置
8479
85-
**不建议直接使用此函数,建议调用overview()后在remote属性内使用updateConfig方法按需更新**
80+
**不建议直接使用此函数,建议调用overview()后在remote属性内使用节点对象的updateConfig方法按需更新**
8681
87-
参数:
88-
- daemonId (str): 节点的唯一标识符。
89-
- config (dict): 节点的配置信息,以字典形式提供,缺失内容由DaemonConfig模型补全。
82+
:params daemonId: 节点的UUID
83+
:params config: 节点的配置信息,以字典形式提供,缺失内容由DaemonConfig模型补全
9084
91-
返回:
92-
- bool: 更新成功后返回True
85+
:returns: 更新成功后返回True
9386
"""
9487
return send(
9588
"PUT",
9689
f"{ApiPool.SERVICE}/remote_service",
9790
params={"uuid": daemonId},
98-
data=DaemonConfig(**config).dict(),
91+
data=DaemonConfig(**config).model_dump(),
9992
)

0 commit comments

Comments
 (0)