🐛 修复无法获取实例文件列表问题，为部分模型增加注释

Author: molanp

example/use_case/get_all_instance_info.py

@@ -40,4 +40,5 @@ def get_all_instance_info(daemon_id: str):
 
 # Optional: Save info to a file in the current directory
 with open("instance_info.json", "w") as f:
-    json.dump(instance_info, f, indent=4)
+    content = json.dump(instance_info, f, indent=4)
+    f.write(content)

mcsmapi/apis/file.py

@@ -13,6 +13,7 @@ def show(
         target: str = "",
         page: int = 0,
         page_size: int = 100,
+        file_name: str = ""
     ) -> FileList:
         """
         获取文件列表
@@ -23,6 +24,7 @@ def show(
         - target (str, 可选): 用于文件过滤的目标路径。默认为空字符串，表示不按路径过滤。
         - page (int, 可选): 指定分页的页码。默认为0。
         - page_size (int, 可选): 指定每页的文件数量。默认为100。
+        - file_name (str, 可选): 用于在文件列表中过滤出名称包含指定字符串的文件或文件夹
 
         **返回:**
         - FileList: 包含文件列表信息和分页详情的FileList模型。
@@ -36,6 +38,7 @@ def show(
                 "target": target,
                 "page": page,
                 "page_size": page_size,
+                "file_name": file_name
             },
         )
         return FileList(**result, daemonId=daemonId, uuid=uuid)

mcsmapi/models/daemon.py

@@ -4,48 +4,79 @@
 
 
 class CpuMemChart(BaseModel):
+    """cpu使用率"""
     cpu: float = 0
+    """内存使用率"""
     mem: float = 0
 
 
 class ProcessInfo(BaseModel):
+    """远程节点使用的cpu资源(单位: byte)"""
     cpu: int = 0
+    """远程节点使用的内存资源(单位: byte)"""
     memory: int = 0
+    """远程节点的工作路径"""
     cwd: str = ""
 
 
 class InstanceInfo(BaseModel):
+    """运行中实例数量"""
     running: int = 0
+    """全部实例数量"""
     total: int = 0
 
 
 class SystemInfo(BaseModel):
+    """系统类型"""
     type: str = ""
+    """主机名"""
     hostname: str = ""
+    """平台架构"""
     platform: str = ""
+    """系统版本"""
     release: str = ""
+    """系统运行时间(单位: sec)"""
     uptime: float = 0
+    """远程节点运行路径"""
     cwd: str = ""
+    """系统负载平均值（仅适用于 Linux 和 macOS），表示过去 **1 分钟、5 分钟、15 分钟** 内的 CPU 负载情况"""
     loadavg: List[float] = []
+    """可用内存(单位: byte)"""
     freemem: int = 0
+    """cpu使用率"""
     cpuUsage: float = 0
+    """内存使用率"""
     memUsage: float = 0
+    """内存总量(单位: byte)"""
     totalmem: int = 0
+    """未知，在MCSM代码中始终为0"""
     processCpu: int = 0
+    """未知，在MCSM代码中始终为0"""
     processMem: int = 0
 
 
 class DaemonModel(BaseModel):
+    """远程节点版本"""
     version: str = ""
+    """远程节点的基本信息"""
     process: ProcessInfo = ProcessInfo()
+    """远程节点实例基本信息"""
     instance: InstanceInfo = InstanceInfo()
+    """远程节点系统信息"""
     system: SystemInfo = SystemInfo()
+    """cpu和内存使用趋势"""
     cpuMemChart: List[CpuMemChart] = []
+    """远程节点的uuid"""
     uuid: str = ""
+    """远程节点的ip"""
     ip: str = ""
+    """远程节点的端口"""
     port: int = 24444
+    """远程节点的路径前缀"""
     prefix: str = ""
+    """远程节点的可用状态"""
     available: bool = False
+    """远程节点的备注"""
     remarks: str = ""
 
     def delete(self) -> bool:

mcsmapi/models/file.py

@@ -4,14 +4,24 @@
 
 
 class FileItem(BaseModel):
+    """文件名称"""
     name: str = "New File"
+    """文件大小(单位: byte)"""
     size: int = 0  # byte
+    """文件修改时间"""
     time: str = ""
+    """文件操作权限(仅适用于Linux)"""
     mode: int = 777  # Linux file permission
+    """文件类型，`0`为文件夹，`1`为文件"""
     type: int = 0  # 0 = Folder, 1 = File
+    """远程节点uuid"""
     daemonId: str = ""
+    """实例的uiid"""
     uuid: str = ""
+    """文件所在路径"""
     target: str = ""
+    """当前文件列表过滤条件"""
+    file_name: str = ""
 
     def rename(self, newName: str) -> bool:
         """
@@ -139,13 +149,21 @@ def download(self) -> str:
 
 
 class FileList(BaseModel):
+    """文件信息列表"""
     items: List[FileItem]
+    """当前页数"""
     page: int = 0
+    """文件列表单页大小"""
     pageSize: int = 100
+    """总页数"""
     total: int = 0
+    """当前路径在远程节点的绝对路径"""
     absolutePath: str = "\\"
+    """远程节点uuid"""
     daemonId: str = ""
+    """实例uuid"""
     uuid: str = ""
+    """文件（名称或目录）路径"""
     target: str = ""
 
     def __init__(self, **data: str):
@@ -200,5 +218,7 @@ def createFloder(self, target: str) -> bool:
 
 
 class CommonConfig(BaseModel):
+    """文件下载密码"""
     password: str = ""
+    """文件下载地址"""
     addr: str = ""

mcsmapi/models/instance.py

@@ -73,7 +73,7 @@ class InstanceDetail(BaseModel):
     daemonId: str = ""
     instanceUuid: str = ""
     processInfo: ProcessInfo = ProcessInfo()
-    space: int = 0
+    space: int = 0 # 在MCSM代码中，此项始终为0，意义不明
     started: int = 0  # 启动次数
     status: int = 0  # -1 = 忙碌, 0 = 停止, 1 = 停止中, 2 = 启动中, 3 = 运行中
 

pyproject.toml

@@ -4,7 +4,7 @@ requires = ["setuptools", "wheel"]
 
 [project]
 name = "mcsmapi"
-version = "0.1.5.b1"
+version = "0.1.5.b2"
 description = "Shortcut the pypi package of MCSM./快捷操作MCSM的pypi包"
 readme = "README.md"
 authors = [