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

mcsmapi/models/common.py

@@ -0,0 +1,30 @@
+from pydantic import BaseModel
+
+
+class CpuMemChart(BaseModel):
+    """资源使用率信息"""
+
+    cpu: float
+    """cpu使用率"""
+    mem: float
+    """内存使用率"""
+
+
+class ProcessInfo(BaseModel):
+    """进程详细信息"""
+
+    cpu: int
+    """CPU 使用率（百分比）"""
+    memory: int
+    """内存使用量（MB）"""
+    cwd: str
+    """工作路径"""
+
+
+class InstanceInfo(BaseModel):
+    """实例统计信息"""
+
+    running: int
+    """运行中实例数量"""
+    total: int
+    """全部实例数量"""

mcsmapi/models/daemon.py

@@ -1,182 +1,146 @@
-from typing import Any, List
+from typing import Any
 from pydantic import BaseModel
 from mcsmapi.models.instance import InstanceCreateResult
+from mcsmapi.models.common import ProcessInfo, InstanceInfo, CpuMemChart
 
 
-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):
+class DaemonSystemInfo(BaseModel):
     """节点系统信息"""
 
+    type: str
     """系统类型"""
-    type: str = ""
+    hostname: str
     """主机名"""
-    hostname: str = ""
+    platform: str
     """平台架构"""
-    platform: str = ""
+    release: str
     """系统版本"""
-    release: str = ""
+    uptime: float
     """系统运行时间(单位: sec)"""
-    uptime: float = 0
+    cwd: str
     """远程节点运行路径"""
-    cwd: str = ""
+    loadavg: tuple[float, float, float]
     """系统负载平均值（仅适用于 Linux 和 macOS），表示过去 **1 分钟、5 分钟、15 分钟** 内的 CPU 负载情况"""
-    loadavg: List[float] = []
+    freemem: int
     """可用内存(单位: byte)"""
-    freemem: int = 0
+    cpuUsage: float
     """cpu使用率"""
-    cpuUsage: float = 0
+    memUsage: float
     """内存使用率"""
-    memUsage: float = 0
+    totalmem: int
     """内存总量(单位: byte)"""
-    totalmem: int = 0
-    """未知，在MCSM代码中始终为0"""
-    processCpu: int = 0
-    """未知，在MCSM代码中始终为0"""
-    processMem: int = 0
+    processCpu: int
+    """未知"""
+    processMem: int
+    """未知"""
 
 
 class DaemonModel(BaseModel):
     """节点详细信息"""
 
+    version: str
     """远程节点版本"""
-    version: str = ""
+    process: ProcessInfo
     """远程节点的基本信息"""
-    process: ProcessInfo = ProcessInfo()
+    instance: InstanceInfo
     """远程节点实例基本信息"""
-    instance: InstanceInfo = InstanceInfo()
+    system: DaemonSystemInfo
     """远程节点系统信息"""
-    system: SystemInfo = SystemInfo()
+    cpuMemChart: list[CpuMemChart]
     """cpu和内存使用趋势"""
-    cpuMemChart: List[CpuMemChart] = []
+    uuid: str
     """远程节点的uuid"""
-    uuid: str = ""
+    ip: str
     """远程节点的ip"""
-    ip: str = ""
+    port: int
     """远程节点的端口"""
-    port: int = 24444
+    prefix: str
     """远程节点的路径前缀"""
-    prefix: str = ""
+    available: bool
     """远程节点的可用状态"""
-    available: bool = False
-    """远程节点的备注"""
-    remarks: str = ""
+    remarks: str
+    """远程节点的名称"""
 
-    def delete(self) -> bool:
+    def delete(self):
         """
-        删除该节点。
+        删除该节点
 
-        返回:
-        - bool: 删除成功后返回True
+        :returns: 删除成功后返回True
         """
         from mcsmapi.apis.daemon import Daemon
 
-        return Daemon().delete(self.uuid)
+        return Daemon.delete(self.uuid)
 
-    def link(self) -> bool:
+    def link(self):
         """
-        链接该节点。
+        尝试连接该节点
 
-        返回:
-        - bool: 链接成功后返回True
+        :returns: 连接成功后返回True
         """
         from mcsmapi.apis.daemon import Daemon
 
-        return Daemon().link(self.uuid)
+        return Daemon.link(self.uuid)
 
     def updateConfig(self, config: dict[str, Any]) -> bool:
         """
-        更新该节点的配置。
+        更新该节点的配置
 
-        参数:
-        - config (dict[str, Any]): 节点的配置信息，以字典形式提供，缺失内容使用原节点配置填充。
+        :params config: 节点的配置信息，以字典形式提供，缺失内容使用原节点配置填充
 
-        返回:
-        - bool: 更新成功后返回True
+        :returns: 更新成功后返回True
         """
         from mcsmapi.apis.daemon import Daemon
 
-        updated_config = self.dict()
+        updated_config = self.model_dump()
         updated_config.update(config)
         # 过滤节点配置中不需要的字段
         daemon_config_dict = {
             key: updated_config[key]
-            for key in DaemonConfig.__fields__.keys()
+            for key in DaemonConfig.model_fields.keys()
             if key in updated_config
         }
 
-        daemon_config = DaemonConfig(**daemon_config_dict).dict()
+        daemon_config = DaemonConfig(**daemon_config_dict).model_dump()
 
-        return Daemon().update(self.uuid, daemon_config)
+        return Daemon.update(self.uuid, daemon_config)
 
-    def createInstance(self, config: dict[str, Any]) -> "InstanceCreateResult":
+    def createInstance(self, config: dict[str, Any]) -> InstanceCreateResult:
         """
-        在当前节点创建一个实例。
+        在当前节点创建一个实例
 
-        参数:
-        - config (dict[str, Any]): 实例的配置信息，以字典形式提供，缺失内容由InstanceConfig模型补全。
+        :params config: 实例的配置信息，以字典形式提供，缺失内容由InstanceConfig模型补全
 
-        返回:
-        - InstanceCreateResult: 一个包含新创建实例信息的结果对象，内容由InstanceCreateResult模型定义。
+        :returns: 一个包含新创建实例信息的结果对象
         """
         from mcsmapi.apis.instance import Instance
         from .instance import InstanceConfig
 
-        return Instance().create(self.uuid, InstanceConfig(**config).dict())
+        return Instance.create(self.uuid, InstanceConfig(**config).model_dump())
 
     def deleteInstance(self, uuids: list[str], deleteFile=False) -> list[str]:
         """
-        删除当前节点的一个或多个实例。
+        删除当前节点的一个或多个实例
 
-        参数:
-        - uuids (list[str]): 要删除的实例UUID列表。
-        - deleteFile (bool, optional): 是否删除关联的文件，默认为False。
+        :params uuids: 要删除的实例UUID列表
+        :params deleteFile: 是否删除关联的文件
 
-        返回:
-        - list[str]: 删除操作后返回的UUID列表。
+        :returns: 删除操作后返回的UUID列表
         """
         from mcsmapi.apis.instance import Instance
 
-        return Instance().delete(self.uuid, uuids, deleteFile)
+        return Instance.delete(self.uuid, uuids, deleteFile)
 
 
 class DaemonConfig(BaseModel):
     """节点配置信息"""
 
-    """远程节点的ip"""
     ip: str = "localhost"
-    """远程节点的端口"""
+    """远程节点的ip"""
     port: int = 24444
-    """远程节点的路径前缀"""
+    """远程节点的端口"""
     prefix: str = ""
-    """远程节点的备注"""
+    """远程节点的路径前缀"""
     remarks: str = "New Daemon"
-    """远程节点的可用状态"""
+    """远程节点的备注"""
     available: bool = True
+    """远程节点的可用状态"""

mcsmapi/models/file.py

@@ -1,151 +1,161 @@
+from enum import IntEnum
+from typing import Literal
 from pydantic import BaseModel
-from typing import List
 import os
 
 
+class FileType(IntEnum):
+    FOLDER = 0
+    FILE = 1
+
+
 class FileItem(BaseModel):
     """文件信息"""
 
+    name: str
     """文件名称"""
-    name: str = ""
+    size: int
     """文件大小(单位: byte)"""
-    size: int = 0  # byte
+    time: str
     """文件修改时间"""
-    time: str = ""
+    mode: int
     """文件操作权限(仅适用于Linux)"""
-    mode: int = 777  # Linux file permission
-    """文件类型，`0`为文件夹，`1`为文件"""
-    type: int = 0  # 0 = Folder, 1 = File
-    """远程节点uuid"""
+    type: FileType
+    """文件类型"""
     daemonId: str = ""
-    """实例的uiid"""
+    """远程节点uuid"""
     uuid: str = ""
-    """文件所在路径"""
+    """实例的uiid"""
     target: str = ""
+    """文件所在路径"""
+    file_name: str
     """当前文件列表过滤条件"""
-    file_name: str = ""
 
-    def rename(self, newName: str) -> bool:
+    def rename(self, newName: str):
         """
-        重命名该文件或文件夹。
+        重命名该文件或文件夹
 
-        **参数:**
-        - new_name (str): 源文件或文件夹的新名字。
+        :params new_name: 源文件或文件夹的新名字
 
-        **返回:**
-        - bool: 重命名成功后返回True。
+        :returns: 重命名成功后返回True
         """
         from mcsmapi.apis.file import File
 
-        return File().rename(
+        return File.rename(
             self.daemonId, self.uuid, os.path.join(self.target, self.name), newName
         )
 
-    def delete(self) -> bool:
+    def delete(self):
         """
-        删除该文件或文件夹。
+        删除该文件或文件夹
 
-        **返回:**
-        - bool: 重命名成功后返回True。
+        :returns: 重命名成功后返回True
         """
         from mcsmapi.apis.file import File
 
-        return File().delete(
+        return File.delete(
             self.daemonId, self.uuid, [os.path.join(self.target, self.name)]
         )
 
-    def copy(self, target: str) -> bool:
+    def copy(self, target: str):
+        """
+        复制该文件或文件夹到目标路径
+
+        :param target: 目标路径
+
+        :returns: 复制成功后返回True
+        """
         from mcsmapi.apis.file import File
 
-        return File().copyOne(
+        return File.copyOne(
             self.daemonId, self.uuid, os.path.join(self.target, self.name), target
         )
 
-    def move(self, target: str) -> bool:
+    def move(self, target: str):
         """
-        移动该文件或文件夹到目标路径。
+        移动该文件或文件夹到目标路径
 
-        **参数:**
-        - target (str): 目标文件或文件夹的路径。
+        :params target: 目标文件或文件夹的路径
 
-        **返回:**
-        - bool: 移动成功后返回True。
+        :returns: 移动成功后返回True
         """
         from mcsmapi.apis.file import File
 
-        return File().moveOne(
+        return File.moveOne(
             self.daemonId, self.uuid, os.path.join(self.target, self.name), target
         )
 
     def content(self):
         """
-        获取文件内容。
-        **返回:**
-        - str | bytes: 文件内容。
+        获取文件内容
+
+        :returns: 文件内容
         """
         from mcsmapi.apis.file import File
 
-        return File().content(
+        return File.content(
             self.daemonId, self.uuid, os.path.join(self.target, self.name)
         )
 
-    def zip(self, targets: list[str]) -> bool:
+    def zip(self, targets: list[str]):
         """
-        压缩多个文件或文件夹到指定位置。
+        压缩多个文件或文件夹到指定位置
 
         **参数:**
-        - targets (list): 要压缩到的目标文件的路径。
+        - targets (list): 要压缩到的目标文件的路径
 
         **返回:**
-        - bool: 压缩成功后返回True。
+        - bool: 压缩成功后返回True
         """
         from mcsmapi.apis.file import File
 
-        return File().zip(
+        return File.zip(
             self.daemonId, self.uuid, os.path.join(self.target, self.name), targets
         )
 
-    def unzip(self, target: str, code: str = "utf-8") -> bool:
+    def unzip(
+        self, target: str, code: Literal["utf-8", "gbk", "big5"] = "utf-8"
+    ) -> bool:
         """
-        解压缩该 zip 文件到目标位置。
+        解压缩该 zip 文件到目标位置
 
         **参数:**
-        - target (str): 解压到的目标路径。
-        - code (str, optional): 压缩文件的编码方式，默认为"utf-8"。
+        - target (str): 解压到的目标路径
+        - code (str, optional): 压缩文件的编码方式，默认为"utf-8"
             可选值: utf-8, gbk, big5
 
         **返回:**
-        - bool: 解压成功后返回True。
+        - bool: 解压成功后返回True
         """
         from mcsmapi.apis.file import File
 
-        return File().unzip(
+        return File.unzip(
             self.daemonId, self.uuid, os.path.join(self.target, self.name), target, code
         )
 
     def update(self, text: str) -> bool:
         """
-        更新该文件内容。
+        更新该文件内容
         **参数:**
-        - text (str): 文件内容。
+        - text (str): 文件内容
         **返回:**
-        - bool: 更新成功后返回True。
+        - bool: 更新成功后返回True
         """
         from mcsmapi.apis.file import File
 
-        return File().update(
+        return File.update(
             self.daemonId, self.uuid, os.path.join(self.target, self.name), text
         )
 
     def download(self) -> str:
         """
-        下载该文件。
+        下载该文件
         **返回:**
-        - str: 文件下载的URL。
+        - str: 文件下载的URL
         """
         from mcsmapi.apis.file import File
 
-        return File().download(
+        return File.download(
             self.daemonId, self.uuid, os.path.join(self.target, self.name)
         )
 
@@ -153,22 +163,22 @@ class FileItem(BaseModel):
 class FileList(BaseModel):
     """文件列表"""
 
+    items: list[FileItem]
     """文件信息列表"""
-    items: List[FileItem]
+    page: int
     """当前页数"""
-    page: int = 0
+    pageSize: int
     """文件列表单页大小"""
-    pageSize: int = 100
+    total: int
     """总页数"""
-    total: int = 0
+    absolutePath: str
     """当前路径在远程节点的绝对路径"""
-    absolutePath: str = "\\"
+    daemonId: str
     """远程节点uuid"""
-    daemonId: str = ""
+    uuid: str
     """实例uuid"""
-    uuid: str = ""
+    target: str
     """文件（名称或目录）路径"""
-    target: str = ""
 
     def __init__(self, **data: str):
         super().__init__(**data)
@@ -179,50 +189,51 @@ class FileList(BaseModel):
 
     async def upload(self, file: bytes, upload_dir: str) -> bool:
         """
-        上传文件到实例。
+        上传文件到实例
 
         **参数:**
-        - file (bytes): 要上传的文件内容。
-        - upload_dir (str): 上传文件的目标目录(包含文件名)。
+        - file (bytes): 要上传的文件内容
+        - upload_dir (str): 上传文件的目标目录(包含文件名)
 
         **返回:**
-        - bool: 返回操作结果，成功时返回True。
+        - bool: 操作成功返回True
         """
         from mcsmapi.apis.file import File
 
-        return await File().upload(self.daemonId, self.uuid, file, upload_dir)
+        return await File.upload(self.daemonId, self.uuid, file, upload_dir)
 
     def createFile(self, target: str) -> bool:
         """
-        创建文件。
+        创建文件
 
         **参数:**
-        - target (str): 目标文件的路径，包含文件名。
+        - target (str): 目标文件的路径，包含文件名
 
         **返回:**
-        - bool: 创建成功后返回True。
+        - bool: 创建成功后返回True
         """
         from mcsmapi.apis.file import File
 
-        return File().createFile(self.daemonId, self.uuid, target)
+        return File.createFile(self.daemonId, self.uuid, target)
 
-    def createFloder(self, target: str) -> bool:
+    def createFolder(self, target: str) -> bool:
         """
         创建文件夹
 
         **参数:**
-        - target (str): 目标文件夹的路径。
+        - target (str): 目标文件夹的路径
 
         **返回:**
-        - bool: 创建成功后返回True。
+        - bool: 创建成功后返回True
         """
         from mcsmapi.apis.file import File
 
-        return File().createFloder(self.daemonId, self.uuid, target)
+        return File.createFolder(self.daemonId, self.uuid, target)
+
 
+class FileDownloadConfig(BaseModel):
 
-class CommonConfig(BaseModel):
+    password: str
     """文件下载密码"""
-    password: str = ""
+    addr: str
     """文件下载地址"""
-    addr: str = ""