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

mcsmapi/__init__.py

@@ -1,5 +1,4 @@
 import urllib.parse
-from mcsmapi.models.overview import OverviewModel
 from mcsmapi.pool import ApiPool
 from mcsmapi.apis.file import File
 from mcsmapi.apis.user import User
@@ -11,12 +10,12 @@ from mcsmapi.request import Request
 
 
 class MCSMAPI:
+
     def __init__(self, url: str, timeout: int = 5) -> None:
         split_url = urllib.parse.urlsplit(url)
         Request.set_mcsm_url(
             urllib.parse.urljoin(f"{split_url.scheme}://{split_url.netloc}", "")
         )
-        self.authentication = None
         Request.set_timeout(timeout)
 
     def login(self, username: str, password: str) -> "MCSMAPI":
@@ -35,8 +34,8 @@ class MCSMAPI:
         self.authentication = "apikey"
         return self
 
-    def overview(self) -> OverviewModel:
-        return Overview().init()
+    def overview(self) -> Overview:
+        return Overview()
 
     def instance(self) -> Instance:
         return Instance()

mcsmapi/apis/daemon.py

@@ -2,29 +2,28 @@ from typing import Any
 from mcsmapi.pool import ApiPool
 from mcsmapi.request import send
 from mcsmapi.models.daemon import DaemonConfig, DaemonModel
-from mcsmapi.models.daemon.instance import InstanceDetail
 
 
 class Daemon:
-    def show(self) -> list[DaemonConfig]:
+    @staticmethod
+    def show() -> list[DaemonConfig]:
         """
         获取全部节点配置信息
 
-        返回:
-        - List[DaemonConfig]: 节点的配置信息列表
+        :returns: 节点的配置信息列表
         """
         daemons = send(
             "GET",
             f"{ApiPool.SERVICE}/remote_services_list",
         )
         return [DaemonConfig(**daemon) for daemon in daemons]
-        
-    def system(self) -> list[DaemonModel]:
+
+    @staticmethod
+    def system() -> list[DaemonModel]:
         """
         获取全部节点的系统信息
-        
-        返回:
-        - List[DaemonModel]: 节点系统信息列表
+
+        :returns: 节点系统信息列表
         """
         daemons = send(
             "GET",
@@ -32,66 +31,62 @@ class Daemon:
         )
         return [DaemonModel(**daemon) for daemon in daemons]
 
-    def add(self, config: dict[str, Any]) -> str:
+    @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(),
         )
 
-    def delete(self, daemonId: str) -> bool:
+    @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}
         )
 
-    def link(self, daemonId: str) -> bool:
+    @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}
         )
 
-    def update(self, daemonId: str, config: dict[str, Any]) -> bool:
+    @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,33 +1,32 @@
+from typing import Literal
 from mcsmapi.pool import ApiPool
 from mcsmapi.request import Request, send, upload
-from mcsmapi.models.file import CommonConfig, FileList
+from mcsmapi.models.file import FileDownloadConfig, FileList
 import urllib.parse
 import os
 
 
 class File:
+    @staticmethod
     def show(
-        self,
         daemonId: str,
         uuid: str,
         target: str = "",
         page: int = 0,
         page_size: int = 100,
-        file_name: str = ""
+        file_name: str = "",
     ) -> FileList:
         """
         获取文件列表
 
-        **参数:**
-        - 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",
@@ -43,17 +42,16 @@ class File:
         )
         return FileList(**result, daemonId=daemonId, uuid=uuid)
 
-    def content(self, daemonId: str, uuid: str, target: str) -> str | bytes:
+    @staticmethod
+    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",
@@ -62,18 +60,17 @@ class File:
             data={"target": target},
         )
 
-    def update(self, daemonId: str, uuid: str, target: str, text: str) -> bool:
+    @staticmethod
+    def update(daemonId: str, uuid: str, target: str, text: str) -> bool:
         """
         更新文件内容
 
-        **参数:**
-        - 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",
@@ -82,17 +79,16 @@ class File:
             data={"target": target, "text": text},
         )
 
-    def download(self, daemonId: str, uuid: str, file_name: str) -> str:
+    @staticmethod
+    def download(daemonId: str, uuid: str, file_name: str) -> str:
         """
         下载文件
 
-        **参数:**
-        - 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(
@@ -100,49 +96,45 @@ class File:
             f"{ApiPool.FILE}/download",
             params={"daemonId": daemonId, "uuid": uuid, "file_name": file_name},
         )
-        result = CommonConfig(**result)
+        result = FileDownloadConfig(**result)
         protocol = Request.mcsm_url.split("://")[0]
         base_url = urllib.parse.urljoin(f"{protocol}://{result.addr}", "download")
         return urllib.parse.urljoin(base_url, f"{result.password}/{file_name}")
 
-    async def upload(
-        self, daemonId: str, uuid: str, file: bytes, upload_dir: str
-    ) -> bool:
+    @staticmethod
+    async def upload(daemonId: str, uuid: str, file: bytes, upload_dir: str) -> bool:
         """
         上传文件
 
-        **参数:**
-        - 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",
             f"{ApiPool.FILE}/upload",
             params={"daemonId": daemonId, "uuid": uuid, "upload_dir": upload_dir},
         )
-        result = CommonConfig(**result)
+        result = FileDownloadConfig(**result)
         protocol = Request.mcsm_url.split("://")[0]
         base_url = urllib.parse.urljoin(f"{protocol}://{result.addr}", "upload")
         final_url = urllib.parse.urljoin(base_url, result.password)
         await upload(final_url, file)
         return True
 
-    def copy(self, daemonId: str, uuid: str, copy_map: dict[str, str]) -> bool:
+    @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(
@@ -152,32 +144,30 @@ class File:
             data={"targets": targets},
         )
 
-    def copyOne(self, daemonId: str, uuid: str, source: str, target: str) -> bool:
+    @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 self.copy(daemonId, uuid, {source: target})
+        return File.copy(daemonId, uuid, {source: target})
 
-    def move(self, daemonId: str, uuid: str, copy_map: dict[str, str]) -> bool:
+    @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(
@@ -187,50 +177,48 @@ class File:
             data={"targets": targets},
         )
 
-    def moveOne(self, daemonId: str, uuid: str, source: str, target: str) -> bool:
+    @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 self.move(daemonId, uuid, {source: target})
+        return File.move(daemonId, uuid, {source: target})
 
-    def rename(self, daemonId: str, uuid: str, source: str, new_name: str) -> bool:
+    @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)
-        return self.moveOne(daemonId, uuid, source, target)
+        return File.moveOne(daemonId, uuid, source, target)
 
-    def zip(self, daemonId: str, uuid: str, source: str, targets: list[str]) -> bool:
+    @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",
@@ -239,41 +227,42 @@ class File:
             data={"type": 1, "code": "utf-8", "source": source, "targets": targets},
         )
 
+    @staticmethod
     def unzip(
-        self, 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},
         )
 
-    def delete(self, daemonId: str, uuid: str, targets: list[str]) -> bool:
+    @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",
@@ -282,17 +271,16 @@ class File:
             data={"targets": targets},
         )
 
-    def createFile(self, daemonId: str, uuid: str, target: str) -> bool:
+    @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",
@@ -301,17 +289,16 @@ class File:
             data={"target": target},
         )
 
-    def createFloder(self, daemonId: str, uuid: str, target: str) -> bool:
+    @staticmethod
+    def createFolder(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",