mcsmapi 0.1.7__py3-none-any.whl → 0.1.8b1__py3-none-any.whl

mcsmapi/apis/daemon.py

@@ -10,8 +10,7 @@ class Daemon:
         """
         获取全部节点配置信息
 
-        返回:
-        - List[DaemonConfig]: 节点的配置信息列表
+        :returns: 节点的配置信息列表
         """
         daemons = send(
             "GET",
@@ -24,8 +23,7 @@ class Daemon:
         """
         获取全部节点的系统信息
 
-        返回:
-        - List[DaemonModel]: 节点系统信息列表
+        :returns: 节点系统信息列表
         """
         daemons = send(
             "GET",
@@ -36,64 +34,59 @@ class Daemon:
     @staticmethod
     def add(config: dict[str, Any]) -> str:
         """
-        新增一个节点。
+        新增一个节点
 
-        参数:
-        - config (dict): 节点的配置信息，以字典形式提供，缺失内容由DaemonConfig模型补全。
+        :params config: 节点的配置信息，以字典形式提供，缺失内容由DaemonConfig模型补全
 
-        返回:
-        - str: 新增节点的ID
+        :returns: 新增节点的UUID
         """
         return send(
             "POST",
             f"{ApiPool.SERVICE}/remote_service",
-            data=DaemonConfig(**config).dict(),
+            data=DaemonConfig(**config).model_dump(),
         )
+
     @staticmethod
     def delete(daemonId: str) -> bool:
         """
-        删除一个节点。
+        删除一个节点
 
-        参数:
-        - daemonId (str): 节点的唯一标识符。
+        :params daemonId: 节点的UUID
 
-        返回:
-        - bool: 删除成功后返回True
+        :returns: 删除成功后返回True
         """
         return send(
             "DELETE", f"{ApiPool.SERVICE}/remote_service", params={"uuid": daemonId}
         )
+
     @staticmethod
     def link(daemonId: str) -> bool:
         """
-        连接一个节点。
+        连接一个节点
 
-        参数:
-        - daemonId (str): 节点的唯一标识符。
+        :params daemonId: 节点的UUID
 
-        返回:
-        - bool: 连接成功后返回True
+        :returns: 连接成功后返回True
         """
         return send(
             "GET", f"{ApiPool.SERVICE}/link_remote_service", params={"uuid": daemonId}
         )
+
     @staticmethod
     def update(daemonId: str, config: dict[str, Any]) -> bool:
         """
-        更新一个节点的配置。
+        更新一个节点的配置
 
-        **不建议直接使用此函数，建议调用overview()后在remote属性内使用updateConfig方法按需更新**
+        **不建议直接使用此函数，建议调用overview()后在remote属性内使用节点对象的updateConfig方法按需更新**
 
-        参数:
-        - daemonId (str): 节点的唯一标识符。
-        - config (dict): 节点的配置信息，以字典形式提供，缺失内容由DaemonConfig模型补全。
+        :params daemonId: 节点的UUID
+        :params config: 节点的配置信息，以字典形式提供，缺失内容由DaemonConfig模型补全
 
-        返回:
-        - bool: 更新成功后返回True
+        :returns: 更新成功后返回True
         """
         return send(
             "PUT",
             f"{ApiPool.SERVICE}/remote_service",
             params={"uuid": daemonId},
-            data=DaemonConfig(**config).dict(),
+            data=DaemonConfig(**config).model_dump(),
         )

mcsmapi/apis/file.py

@@ -1,3 +1,4 @@
+from typing import Literal
 from mcsmapi.pool import ApiPool
 from mcsmapi.request import Request, send, upload
 from mcsmapi.models.file import FileDownloadConfig, FileList
@@ -18,16 +19,14 @@ class File:
         """
         获取文件列表
 
-        **参数:**
-        - daemonId (str): 守护进程的唯一标识符。
-        - uuid (str): 文件实例的唯一标识符。
-        - target (str, 可选): 用于文件过滤的目标路径。默认为空字符串，表示不按路径过滤。
-        - page (int, 可选): 指定分页的页码。默认为0。
-        - page_size (int, 可选): 指定每页的文件数量。默认为100。
-        - file_name (str, 可选): 用于在文件列表中过滤出名称包含指定字符串的文件或文件夹
+        :params daemonId: 节点的UUID
+        :params uuid: 实例的UUID
+        :params target: 用于文件过滤的目标路径
+        :params page: 指定分页的页码
+        :params page_size: 指定每页的文件数量
+        :params file_name: 用于在文件列表中过滤出名称包含指定字符串的文件或文件夹
 
-        **返回:**
-        - FileList: 包含文件列表信息和分页详情的FileList模型。
+        :returns: 包含文件列表信息和分页详情的FileList模型
         """
         result = send(
             "GET",
@@ -44,17 +43,15 @@ class File:
         return FileList(**result, daemonId=daemonId, uuid=uuid)
 
     @staticmethod
-    def content(daemonId: str, uuid: str, target: str) -> str | bytes:
+    def content(daemonId: str, uuid: str, target: str) -> str:
         """
         获取文件内容
 
-        **参数:**
-        - daemonId (str): 守护进程的唯一标识符。
-        - uuid (str): 文件实例的唯一标识符。
-        - target (str): 文件的目标路径。
+        :params daemonId: 节点的UUID
+        :params uuid: 实例的UUID
+        :params target: 文件的目标路径
 
-        **返回:**
-        - str: 文件的内容信息。
+        :returns: 文件的内容信息
         """
         return send(
             "PUT",
@@ -68,14 +65,12 @@ class File:
         """
         更新文件内容
 
-        **参数:**
-        - daemonId (str): 守护进程的唯一标识符。
-        - uuid (str): 文件实例的唯一标识符。
-        - target (str): 文件的目标路径。
-        - text (str): 新的文件内容。
+        :params daemonId: 节点的UUID
+        :params uuid: 实例的UUID
+        :params target: 目标文件的路径
+        :params text: 新的文件内容
 
-        **返回:**
-        - bool: 更新成功后返回True。
+        :returns: 更新成功后返回True
         """
         return send(
             "PUT",
@@ -89,13 +84,11 @@ class File:
         """
         下载文件
 
-        **参数:**
-        - daemonId (str): 守护进程的唯一标识符。
-        - uuid (str): 文件实例的唯一标识符。
-        - file_name (str): 要下载的文件名。路径+名字, 示例: /backup/world.zip
+        :params daemonId: 节点的UUID
+        :params uuid: 实例的UUID
+        :params file_name: 要下载的文件的实例内完整路径, eg: /backup/world.zip
 
-        **返回:**
-        - str: 文件下载URL。
+        :returns: 文件下载URL
         """
 
         result = send(
@@ -113,14 +106,12 @@ class File:
         """
         上传文件
 
-        **参数:**
-        - daemonId (str): 守护进程的唯一标识符。
-        - uuid (str): 文件实例的唯一标识符。
-        - file (bytes): 要上传的文件内容。
-        - upload_dir (str): 文件上传到的目标路径。
+        :params daemonId: 节点的UUID
+        :params uuid: 实例的UUID
+        :params file: 要上传的文件内容
+        :params upload_dir: 文件上传到的目标路径
 
-        **返回:**
-        - bool: 上传成功后返回True。
+        :returns: 上传成功后返回True
         """
         result = send(
             "POST",
@@ -137,15 +128,13 @@ class File:
     @staticmethod
     def copy(daemonId: str, uuid: str, copy_map: dict[str, str]) -> bool:
         """
-        复制多个文件夹或文件到指定位置。
+        复制多个文件夹或文件到指定位置
 
-        **参数:**
-        - daemonId (str): 守护进程的唯一标识符。
-        - uuid (str): 文件实例的唯一标识符。
-        - copy_map (dict): 复制映射，格式为 {源路径: 目标路径}
+        :params daemonId: 节点的UUID
+        :params uuid: 实例的UUID
+        :params copy_map: 复制映射，格式为 {源路径: 目标路径}
 
-        **返回:**
-        - bool: 上传成功后返回True。
+        :returns: 复制成功后返回True
         """
         targets = [[source, target] for source, target in copy_map.items()]
         return send(
@@ -158,31 +147,27 @@ class File:
     @staticmethod
     def copyOne(daemonId: str, uuid: str, source: str, target: str) -> bool:
         """
-        复制单个文件或文件夹到指定位置。
+        复制单个文件或文件夹到指定位置
 
-        **参数:**
-        - daemonId (str): 守护进程的唯一标识符。
-        - uuid (str): 实例的唯一标识符。
-        - source (str): 源文件或文件夹的路径。
-        - target (str): 目标文件或文件夹的路径。
+        :params daemonId: 节点的UUID
+        :params uuid: 实例的UUID
+        :params source: 源文件或文件夹的路径
+        :params target: 目标文件或文件夹的路径
 
-        **返回:**
-        - bool: 移动成功后返回True。
+        :return: 移动成功后返回True
         """
         return File.copy(daemonId, uuid, {source: target})
 
     @staticmethod
     def move(daemonId: str, uuid: str, copy_map: dict[str, str]) -> bool:
         """
-        移动多个文件或文件夹到指定位置。
+        移动多个文件或文件夹到指定位置
 
-        参数:
-        - daemonId (str): 守护进程的唯一标识符。
-        - uuid (str): 实例的唯一标识符。
-        - copy_map (dict): 移动映射，格式为 {源路径: 目标路径}
+        :params daemonId: 节点的UUID
+        :params uuid: 实例的UUID
+        :params copy_map: 移动映射，格式为 {源路径: 目标路径}
 
-        返回:
-        - bool: 移动成功后返回True。
+        :returns: 移动成功后返回True
         """
         targets = [[source, target] for source, target in copy_map.items()]
         return send(
@@ -195,32 +180,28 @@ class File:
     @staticmethod
     def moveOne(daemonId: str, uuid: str, source: str, target: str) -> bool:
         """
-        从源路径移动单个文件或文件夹到目标路径。
+        从源路径移动单个文件或文件夹到目标路径
 
-        参数:
-        - daemonId (str): 守护进程的唯一标识符。
-        - uuid (str): 实例的唯一标识符。
-        - source (str): 源文件或文件夹的路径。
-        - target (str): 目标文件或文件夹的路径。
+        :params daemonId: 节点的UUID
+        :params uuid: 实例的UUID
+        :params source: 源文件或文件夹的路径
+        :params target: 目标文件或文件夹的路径
 
-        返回:
-        - bool: 移动成功后返回True。
+        :returns: 移动成功后返回True
         """
         return File.move(daemonId, uuid, {source: target})
 
     @staticmethod
     def rename(daemonId: str, uuid: str, source: str, new_name: str) -> bool:
         """
-        重命名单个文件或文件夹。
+        重命名单个文件或文件夹
 
-        **参数:**
-        - daemonId (str): 守护进程的唯一标识符。
-        - uuid (str): 实例的唯一标识符。
-        - source (str): 源文件或文件夹的路径。
-        - new_name (str): 源文件或文件夹的新名字。
+        :params daemonId: 节点的UUID
+        :params uuid: 实例的UUID
+        :params source: 源文件或文件夹的路径
+        :params new_name: 源文件或文件夹的新名字
 
-        **返回:**
-        - bool: 重命名成功后返回True。
+        :returns: 重命名成功后返回True
         """
         directory = os.path.dirname(source)
         target = os.path.join(directory, new_name)
@@ -229,16 +210,15 @@ class File:
     @staticmethod
     def zip(daemonId: str, uuid: str, source: str, targets: list[str]) -> bool:
         """
-        压缩多个文件或文件夹到指定位置。
+        压缩多个文件或文件夹到指定位置
 
-        **参数:**
-        - daemonId (str): 守护进程的唯一标识符。
-        - uuid (str): 实例的唯一标识符。
-        - source (str): 需要压缩的文件路径。
-        - targets (list): 要压缩到的目标文件的路径。
+        :params daemonId: 节点的UUID
+        :params uuid: 实例的UUID
+        :params source: 要压缩到的目标文件的路径
+        :params targets: 需要压缩的文件路径
 
         **返回:**
-        - bool: 压缩成功后返回True。
+        - bool: 压缩成功后返回True
         """
         return send(
             "POST",
@@ -249,41 +229,40 @@ class File:
 
     @staticmethod
     def unzip(
-        daemonId: str, uuid: str, source: str, target: str, code: str = "utf-8"
+        daemonId: str,
+        uuid: str,
+        source: str,
+        targets: str,
+        code: Literal["utf-8", "gbk", "big5"] = "utf-8",
     ) -> bool:
         """
-        解压缩指定的zip文件到目标位置。
+        解压缩指定的zip文件到目标位置
 
-        **参数:**
-        - daemonId (str): 守护进程的唯一标识符。
-        - uuid (str): 实例的唯一标识符。
-        - source (str): 需要解压的zip文件路径。
-        - target (str): 解压到的目标路径。
-        - code (str, optional): 压缩文件的编码方式，默认为"utf-8"。
-            可选值: utf-8, gbk, big5
+        :params daemonId: 节点的UUID
+        :params uuid: 实例的UUID
+        :params source: 需要解压的zip文件路径
+        :params targets: 解压到的目标路径
+        :params code: 压缩文件的编码方式
 
-        **返回:**
-        - bool: 解压成功后返回True。
+        :returns: 解压成功后返回True
         """
         return send(
             "POST",
             f"{ApiPool.FILE}/compress",
             params={"daemonId": daemonId, "uuid": uuid},
-            data={"type": 2, "code": code, "source": source, "targets": target},
+            data={"type": 2, "code": code, "source": source, "targets": targets},
         )
 
     @staticmethod
     def delete(daemonId: str, uuid: str, targets: list[str]) -> bool:
         """
-        删除多个文件或文件夹。
+        删除多个文件或文件夹
 
-        **参数:**
-        - daemonId (str): 守护进程的唯一标识符。
-        - uuid (str): 实例的唯一标识符。
-        - targets (list): 要删除的文件或文件夹的路径。
+        :params daemonId: 节点的UUID
+        :params uuid: 实例的UUID
+        :params targets: 要删除的文件或文件夹的路径
 
-        **返回:**
-        - bool: 删除成功后返回True。
+        :returns: 删除成功后返回True
         """
         return send(
             "DELETE",
@@ -295,15 +274,13 @@ class File:
     @staticmethod
     def createFile(daemonId: str, uuid: str, target: str) -> bool:
         """
-        创建文件。
+        创建文件
 
-        **参数:**
-        - daemonId (str): 守护进程的唯一标识符。
-        - uuid (str): 实例的唯一标识符。
-        - target (str): 目标文件的路径，包含文件名。
+        :params daemonId: 节点的UUID
+        :params uuid: 实例的UUID
+        :params target: 目标文件的路径，包含文件名
 
-        **返回:**
-        - bool: 创建成功后返回True。
+        :returns: 创建成功后返回True
         """
         return send(
             "POST",
@@ -317,13 +294,11 @@ class File:
         """
         创建文件夹
 
-        **参数:**
-        - daemonId (str): 守护进程的唯一标识符。
-        - uuid (str): 实例的唯一标识符。
-        - target (str): 目标文件夹的路径。
+        :params daemonId: 节点的UUID
+        :params uuid: 实例的UUID
+        :params target: 目标文件夹的路径
 
-        **返回:**
-        - bool: 创建成功后返回True。
+        :returns: 创建成功后返回True
         """
         return send(
             "POST",

mcsmapi/apis/image.py

@@ -9,11 +9,9 @@ class Image:
         """
         获取镜像列表
 
-        **参数:**
-        - daemonId (str): 守护进程的唯一标识符。
+        :params daemonId: 节点的UUID
 
-        **返回:**
-        - list[ImageModel]: 包含镜像列表详情的 ImageModel 模型的列表。
+        :returns: 包含镜像列表详情的 ImageModel 模型的列表
         """
         result = send(
             "GET",
@@ -30,11 +28,9 @@ class Image:
         """
         获取容器列表
 
-        **参数:**
-        - daemonId (str): 守护进程的唯一标识符。
+        :params daemonId: 节点的UUID
 
-        **返回:**
-        - list[DockerContainerItem]: 包含容器列表详情的 DockerContainerItem 模型的列表。
+        :params: 包含容器列表详情的 DockerContainerItem 模型的列表
         """
         result = send(
             "GET",
@@ -51,11 +47,9 @@ class Image:
         """
         获取网络接口列表
 
-        **参数:**
-        - daemonId (str): 守护进程的唯一标识符。
+        :params daemonId: 节点的UUID
 
-        **返回:**
-        - list[DockerNetworkItem]: 包含网络接口列表详情的 DockerNetworkItem 模型的列表。
+        :returns: 包含网络接口列表详情的 DockerNetworkItem 模型的列表
         """
         result = send(
             "GET",
@@ -71,14 +65,12 @@ class Image:
         """
         新增一个镜像
 
-        **参数:**
-        - daemonId (str): 守护进程的唯一标识符。
-        - dockerFile (str): DockerFile Config
-        - name (str): 镜像名称。
-        - tag (str): 镜像版本。
+        :params daemonId: 节点的UUID
+        :params dockerFile: DockerFile Config 内容
+        :params name: 镜像名称
+        :params tag: 镜像版本
 
-        **返回:**
-        - bool: 新增镜像成功后返回True。
+        :returns: 新增镜像成功后返回True
         """
         return send(
             "POST",
@@ -92,13 +84,15 @@ class Image:
         """
         获取镜像构建进度
 
-        ## **由于文档此部分内容不详，未使用模型**
+        :params daemonId: 节点的UUID
 
-        **参数:**
-        - daemonId (str): 守护进程的唯一标识符。
+        :returns: {容器名称: 当前状态}
 
-        **返回:**
-        - dict[str, int]: 包含构建进度信息的字典。
+        状态码对照:
+        ```
+        -1: 镜像构建失败
+         1: 镜像构建中
+         2: 镜像构建完成
         """
         return send(
             "GET",