Skip to content

Commit def6e3b

Browse files
committed
feat: rename new methods
1 parent 0134289 commit def6e3b

File tree

7 files changed

+21
-21
lines changed

7 files changed

+21
-21
lines changed

CHANGELOG.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@
1111

1212
### Added
1313
- 新增 `DockerManager` 类,支持管理 Docker 容器和项目
14-
- `compose_list()`: 获取 Docker Compose 项目列表
15-
- `container_list(all=True)`: 获取容器列表
14+
- `list_composes()`: 获取 Docker Compose 项目列表
15+
- `list_containers(all=True)`: 获取容器列表
1616
- `stats()`: 获取容器统计信息
17-
- `system_setting_get()`: 获取 Docker 系统设置
17+
- `get_system_settings()`: 获取 Docker 系统设置
1818
- 新增 `EventLogger` 类,支持获取事件日志
1919
- `common_list()`: 获取事件日志列表
2020
- 新增 `Share` 类,支持获取共享配置信息

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -117,10 +117,10 @@ if __name__ == "__main__":
117117
| File | `remove` | 删除文件或文件夹 |
118118
| File | `get_acl` | 获取文件的ACL(访问控制列表)信息 |
119119
| DockerManager | `__init__` | 初始化DockerManager类 |
120-
| DockerManager | `compose_list` | 获取Docker Compose项目列表 |
121-
| DockerManager | `container_list` | 获取容器列表(支持all参数,默认为True) |
120+
| DockerManager | `list_composes` | 获取Docker Compose项目列表 |
121+
| DockerManager | `list_containers` | 获取容器列表(支持all参数,默认为True) |
122122
| DockerManager | `stats` | 获取容器统计信息 |
123-
| DockerManager | `system_setting_get` | 获取Docker系统设置 |
123+
| DockerManager | `get_system_settings` | 获取Docker系统设置 |
124124
| EventLogger | `__init__` | 初始化EventLogger类 |
125125
| EventLogger | `common_list` | 获取事件日志列表 |
126126
| Share | `__init__` | 初始化Share类 |

examples/docker_manager.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ async def main():
3131

3232
# 1. 获取 Docker Compose 项目列表
3333
print("\n=== Docker Compose 项目列表 ===")
34-
compose_list = await docker_mgr.compose_list()
34+
compose_list = await docker_mgr.list_composes()
3535
if compose_list.get("result") == "succ":
3636
for project in compose_list["rsp"]:
3737
print(f"项目名称: {project['Name']}")
@@ -42,7 +42,7 @@ async def main():
4242

4343
# 2. 获取容器列表(包含所有容器)
4444
print("\n=== 容器列表 ===")
45-
container_list = await docker_mgr.container_list(all=True)
45+
container_list = await docker_mgr.list_containers(all=True)
4646
if container_list.get("result") == "succ":
4747
for container in container_list["rsp"]:
4848
print(f"容器名称: {container['Names'][0]}")
@@ -65,7 +65,7 @@ async def main():
6565

6666
# 4. 获取 Docker 系统设置
6767
print("\n=== Docker 系统设置 ===")
68-
system_setting = await docker_mgr.system_setting_get()
68+
system_setting = await docker_mgr.get_system_settings()
6969
if system_setting.get("result") == "succ":
7070
settings = system_setting["rsp"]
7171
print(f"数据根目录: {settings['dataRoot']}")

fnos/docker_manager.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ def __init__(self, client: FnosClient):
2929
"""
3030
self.client = client
3131

32-
async def compose_list(self, timeout: float = 10.0) -> dict:
32+
async def list_composes(self, timeout: float = 10.0) -> dict:
3333
"""
3434
获取Docker Compose项目列表
3535
@@ -60,7 +60,7 @@ async def compose_list(self, timeout: float = 10.0) -> dict:
6060
response = await self.client.request_payload_with_response("appcgi.dockermgr.composeList", {}, timeout)
6161
return response
6262

63-
async def container_list(self, all: bool = True, timeout: float = 10.0) -> dict:
63+
async def list_containers(self, all: bool = True, timeout: float = 10.0) -> dict:
6464
"""
6565
获取容器列表
6666
@@ -137,7 +137,7 @@ async def stats(self, timeout: float = 10.0) -> dict:
137137
response = await self.client.request_payload_with_response("appcgi.dockermgr.stats", {}, timeout)
138138
return response
139139

140-
async def system_setting_get(self, timeout: float = 10.0) -> dict:
140+
async def get_system_settings(self, timeout: float = 10.0) -> dict:
141141
"""
142142
获取Docker系统设置
143143

tests/test_dockermgr_compose_list.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@
2222

2323

2424
@pytest.mark.asyncio
25-
async def test_dockermgr_compose_list():
26-
"""测试 DockerManager.compose_list() 方法的集成测试
25+
async def test_dockermgr_list_composes():
26+
"""测试 DockerManager.list_composes() 方法的集成测试
2727
2828
此测试需要:
2929
1. fnOS 服务运行在 127.0.0.1:5666
@@ -50,7 +50,7 @@ async def test_dockermgr_compose_list():
5050
docker_mgr = DockerManager(client)
5151

5252
# 获取 Docker Compose 项目列表
53-
compose_list_result = await docker_mgr.compose_list()
53+
compose_list_result = await docker_mgr.list_composes()
5454

5555
# 验证响应格式
5656
assert compose_list_result.get("result") == "succ", "响应结果不是成功"

tests/test_dockermgr_container_list.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@
2222

2323

2424
@pytest.mark.asyncio
25-
async def test_dockermgr_container_list():
26-
"""测试 DockerManager.container_list() 方法的集成测试
25+
async def test_dockermgr_list_containers():
26+
"""测试 DockerManager.list_containers() 方法的集成测试
2727
2828
此测试需要:
2929
1. fnOS 服务运行在 127.0.0.1:5666
@@ -50,7 +50,7 @@ async def test_dockermgr_container_list():
5050
docker_mgr = DockerManager(client)
5151

5252
# 获取容器列表(包含所有容器)
53-
container_list_result = await docker_mgr.container_list(all=True)
53+
container_list_result = await docker_mgr.list_containers(all=True)
5454

5555
# 验证响应格式
5656
assert container_list_result.get("result") == "succ", "响应结果不是成功"

tests/test_dockermgr_system_setting_get.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@
2222

2323

2424
@pytest.mark.asyncio
25-
async def test_dockermgr_system_setting_get():
26-
"""测试 DockerManager.system_setting_get() 方法的集成测试
25+
async def test_dockermgr_get_system_settings():
26+
"""测试 DockerManager.get_system_settings() 方法的集成测试
2727
2828
此测试需要:
2929
1. fnOS 服务运行在 127.0.0.1:5666
@@ -50,7 +50,7 @@ async def test_dockermgr_system_setting_get():
5050
docker_mgr = DockerManager(client)
5151

5252
# 获取 Docker 系统设置
53-
system_setting_result = await docker_mgr.system_setting_get()
53+
system_setting_result = await docker_mgr.get_system_settings()
5454

5555
# 验证响应格式
5656
assert system_setting_result.get("result") == "succ", "响应结果不是成功"

0 commit comments

Comments
 (0)