mcsmapi 0.1.8b1__py3-none-any.whl → 0.1.8b3__py3-none-any.whl

mcsmapi/__init__.py

@@ -11,14 +11,14 @@ from mcsmapi.request import Request
 
 class MCSMAPI:
 
-    def __init__(self, url: str, timeout: int = 5) -> None:
+    def __init__(self, url: str, timeout: int = 5):
         split_url = urllib.parse.urlsplit(url)
         Request.set_mcsm_url(
             urllib.parse.urljoin(f"{split_url.scheme}://{split_url.netloc}", "")
         )
         Request.set_timeout(timeout)
 
-    def login(self, username: str, password: str) -> "MCSMAPI":
+    def login(self, username: str, password: str):
         Request.set_token(
             Request.send(
                 "POST",
@@ -34,20 +34,20 @@ class MCSMAPI:
         self.authentication = "apikey"
         return self
 
-    def overview(self) -> Overview:
+    def overview(self):
         return Overview()
 
-    def instance(self) -> Instance:
+    def instance(self):
         return Instance()
 
-    def user(self) -> User:
+    def user(self) :
         return User()
 
-    def daemon(self) -> Daemon:
+    def daemon(self):
         return Daemon()
 
-    def file(self) -> File:
+    def file(self):
         return File()
 
-    def image(self) -> Image:
+    def image(self):
         return Image()

mcsmapi/apis/daemon.py

@@ -1,12 +1,18 @@
 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 import (
+    DaemonConfig,
+    DaemonInfo,
+    DaemonSystemInfo,
+    DaemonStatus,
+    DaemonUpdateConfig,
+)
 
 
 class Daemon:
     @staticmethod
-    def show() -> list[DaemonConfig]:
+    def config() -> list[DaemonStatus]:
         """
         获取全部节点配置信息
 
@@ -16,10 +22,23 @@ class Daemon:
             "GET",
             f"{ApiPool.SERVICE}/remote_services_list",
         )
-        return [DaemonConfig(**daemon) for daemon in daemons]
+        return [DaemonStatus(**daemon) for daemon in daemons]
 
     @staticmethod
-    def system() -> list[DaemonModel]:
+    def info() -> list[DaemonInfo]:
+        """
+        获取全部节点信息
+
+        :returns: 节点信息列表
+        """
+        daemons = send(
+            "GET",
+            f"{ApiPool.SERVICE}/remote_services",
+        )
+        return [DaemonInfo(**daemon) for daemon in daemons]
+
+    @staticmethod
+    def system() -> list[DaemonSystemInfo]:
         """
         获取全部节点的系统信息
 
@@ -29,7 +48,7 @@ class Daemon:
             "GET",
             f"{ApiPool.SERVICE}/remote_services_system",
         )
-        return [DaemonModel(**daemon) for daemon in daemons]
+        return [DaemonSystemInfo(**daemon) for daemon in daemons]
 
     @staticmethod
     def add(config: dict[str, Any]) -> str:
@@ -53,7 +72,7 @@ class Daemon:
 
         :params daemonId: 节点的UUID
 
-        :returns: 删除成功后返回True
+        :returns: 操作成功后返回True
         """
         return send(
             "DELETE", f"{ApiPool.SERVICE}/remote_service", params={"uuid": daemonId}
@@ -66,7 +85,7 @@ class Daemon:
 
         :params daemonId: 节点的UUID
 
-        :returns: 连接成功后返回True
+        :returns: 操作成功后返回True
         """
         return send(
             "GET", f"{ApiPool.SERVICE}/link_remote_service", params={"uuid": daemonId}
@@ -77,16 +96,14 @@ class Daemon:
         """
         更新一个节点的配置
 
-        **不建议直接使用此函数，建议调用overview()后在remote属性内使用节点对象的updateConfig方法按需更新**
-
         :params daemonId: 节点的UUID
-        :params config: 节点的配置信息，以字典形式提供，缺失内容由DaemonConfig模型补全
+        :params config: 节点的配置信息，以字典形式提供，缺失内容由DaemonUpdateConfig模型补全
 
-        :returns: 更新成功后返回True
+        :returns: 操作成功后返回True
         """
         return send(
             "PUT",
             f"{ApiPool.SERVICE}/remote_service",
             params={"uuid": daemonId},
-            data=DaemonConfig(**config).model_dump(),
+            data=DaemonUpdateConfig(**config).model_dump(),
         )

mcsmapi/apis/file.py

@@ -70,7 +70,7 @@ class File:
         :params target: 目标文件的路径
         :params text: 新的文件内容
 
-        :returns: 更新成功后返回True
+        :returns: 操作成功后返回True
         """
         return send(
             "PUT",
@@ -111,7 +111,7 @@ class File:
         :params file: 要上传的文件内容
         :params upload_dir: 文件上传到的目标路径
 
-        :returns: 上传成功后返回True
+        :returns: 操作成功后返回True
         """
         result = send(
             "POST",
@@ -134,7 +134,7 @@ class File:
         :params uuid: 实例的UUID
         :params copy_map: 复制映射，格式为 {源路径: 目标路径}
 
-        :returns: 复制成功后返回True
+        :returns: 操作成功后返回True
         """
         targets = [[source, target] for source, target in copy_map.items()]
         return send(
@@ -154,7 +154,7 @@ class File:
         :params source: 源文件或文件夹的路径
         :params target: 目标文件或文件夹的路径
 
-        :return: 移动成功后返回True
+        :returns: 操作成功后返回True
         """
         return File.copy(daemonId, uuid, {source: target})
 
@@ -167,7 +167,7 @@ class File:
         :params uuid: 实例的UUID
         :params copy_map: 移动映射，格式为 {源路径: 目标路径}
 
-        :returns: 移动成功后返回True
+        :returns: 操作成功后返回True
         """
         targets = [[source, target] for source, target in copy_map.items()]
         return send(
@@ -187,7 +187,7 @@ class File:
         :params source: 源文件或文件夹的路径
         :params target: 目标文件或文件夹的路径
 
-        :returns: 移动成功后返回True
+        :returns: 操作成功后返回True
         """
         return File.move(daemonId, uuid, {source: target})
 
@@ -201,7 +201,7 @@ class File:
         :params source: 源文件或文件夹的路径
         :params new_name: 源文件或文件夹的新名字
 
-        :returns: 重命名成功后返回True
+        :returns: 操作成功后返回True
         """
         directory = os.path.dirname(source)
         target = os.path.join(directory, new_name)
@@ -217,8 +217,7 @@ class File:
         :params source: 要压缩到的目标文件的路径
         :params targets: 需要压缩的文件路径
 
-        **返回:**
-        - bool: 压缩成功后返回True
+        :returns: 操作成功后返回True
         """
         return send(
             "POST",
@@ -244,7 +243,7 @@ class File:
         :params targets: 解压到的目标路径
         :params code: 压缩文件的编码方式
 
-        :returns: 解压成功后返回True
+        :returns: 操作成功后返回True
         """
         return send(
             "POST",
@@ -262,7 +261,7 @@ class File:
         :params uuid: 实例的UUID
         :params targets: 要删除的文件或文件夹的路径
 
-        :returns: 删除成功后返回True
+        :returns: 操作成功后返回True
         """
         return send(
             "DELETE",
@@ -280,7 +279,7 @@ class File:
         :params uuid: 实例的UUID
         :params target: 目标文件的路径，包含文件名
 
-        :returns: 创建成功后返回True
+        :returns: 操作成功后返回True
         """
         return send(
             "POST",
@@ -298,7 +297,7 @@ class File:
         :params uuid: 实例的UUID
         :params target: 目标文件夹的路径
 
-        :returns: 创建成功后返回True
+        :returns: 操作成功后返回True
         """
         return send(
             "POST",

mcsmapi/apis/image.py

@@ -70,7 +70,7 @@ class Image:
         :params name: 镜像名称
         :params tag: 镜像版本
 
-        :returns: 新增镜像成功后返回True
+        :returns: 操作成功后返回True
         """
         return send(
             "POST",

mcsmapi/apis/instance.py

@@ -63,7 +63,7 @@ class Instance:
             ApiPool.INSTANCE,
             params={"uuid": uuid, "daemonId": daemonId},
         )
-        return InstanceDetail(**result)
+        return InstanceDetail(**result, daemonId=daemonId)
 
     @staticmethod
     def create(daemonId: str, config: dict[str, Any]) -> InstanceCreateResult:
@@ -94,7 +94,7 @@ class Instance:
         :params uuid: 实例的UUID
         :params config: 新的实例配置，以字典形式提供，缺失内容由InstanceConfig模型补全
 
-        :returns: 更新成功后返回更新的实例UUID
+        :returns: 被更新配置的实例UUID
         """
         result = send(
             "PUT",
@@ -109,7 +109,7 @@ class Instance:
         """
         删除实例
 
-        :params daemonId: 节点的标识符
+        :params daemonId: 节点的UUID
         :params uuids: 要删除的实例UUID列表
         :params deleteFile: 是否删除关联的文件
 
@@ -130,7 +130,7 @@ class Instance:
         :params daemonId: 节点的UUID
         :params uuid: 实例的UUID
 
-        :returns: 返回被操作的实例的UUID
+        :returns: 被启动的实例的UUID
         """
         result = send(
             "GET",
@@ -147,7 +147,7 @@ class Instance:
         :params daemonId: 节点的UUID
         :params uuid: 实例的UUID
 
-        :returns: 返回被操作的实例的UUID
+        :returns: 被关闭的实例的UUID
         """
         result = send(
             "GET",
@@ -164,7 +164,7 @@ class Instance:
         :params daemonId: 节点的UUID
         :params uuid: 实例的UUID
 
-        :returns: 返回被操作的实例的UUID
+        :returns: 被重启的实例的UUID
         """
         result = send(
             "GET",
@@ -181,7 +181,7 @@ class Instance:
         :params daemonId: 节点的UUID
         :params uuid: 实例的UUID
 
-        :returns: 返回被操作的实例的UUID
+        :returns: 被强制关闭的实例的UUID
         """
         result = send(
             "GET",
@@ -230,7 +230,7 @@ class Instance:
         :params uuid: 实例的UUID
         :params command: 要发送的命令
 
-        :params: 返回被操作的实例的UUID
+        :returns: 被操作的实例的UUID
         """
         result = send(
             "GET",

mcsmapi/apis/user.py

@@ -1,7 +1,7 @@
 from typing import Any, Literal
 from mcsmapi.pool import ApiPool
 from mcsmapi.request import send
-from mcsmapi.models.user import SearchUserModel, UserConfig, UserCreateResult
+from mcsmapi.models.user import SearchUserModel, UserCreateResult, UserModel
 
 
 class User:
@@ -60,14 +60,14 @@ class User:
         **不建议直接使用此函数，建议调用search后使用用户对象的update方法按需更新**
 
         :params uuid: 用户的UUID
-        :params config: 新的用户信息，以字典形式提供，缺失内容由 UserConfig 模型提供默认值
+        :params config: 新的用户信息，以字典形式提供，缺失内容由 UserModel 模型提供默认值
 
         :returns: 成功时返回True
         """
         return send(
             "PUT",
             ApiPool.AUTH,
-            data={"uuid": uuid, "config": UserConfig(**config).model_dump()},
+            data={"uuid": uuid, "config": UserModel(**config).model_dump()},
         )
 
     @staticmethod

mcsmapi/models/common.py

@@ -21,7 +21,7 @@ class ProcessInfo(BaseModel):
     """工作路径"""
 
 
-class InstanceInfo(BaseModel):
+class InstanceStat(BaseModel):
     """实例统计信息"""
 
     running: int

mcsmapi/models/daemon.py

@@ -1,10 +1,10 @@
 from typing import Any
 from pydantic import BaseModel
-from mcsmapi.models.instance import InstanceCreateResult
-from mcsmapi.models.common import ProcessInfo, InstanceInfo, CpuMemChart
+from mcsmapi.models.instance import InstanceCreateResult, InstanceDetail
+from mcsmapi.models.common import ProcessInfo, InstanceStat, CpuMemChart
 
 
-class DaemonSystemInfo(BaseModel):
+class SystemInfo(BaseModel):
     """节点系统信息"""
 
     type: str
@@ -29,43 +29,53 @@ class DaemonSystemInfo(BaseModel):
     """内存使用率"""
     totalmem: int
     """内存总量(单位: byte)"""
-    processCpu: int
-    """未知"""
-    processMem: int
+
+
+class DaemonSetting(BaseModel):
+    """节点系统配置信息"""
+
+    language: str
+    """节点语言"""
+    uploadSpeedRate: int
+    """上传速度限制(0为不限制, 限制为(n * 64)KB/s)"""
+    downloadSpeedRate: int
+    """下载速度限制(0为不限制, 限制为(n * 64)KB/s)"""
+    portRangeStart: int
+    """端口范围起始值"""
+    portRangeEnd: int
+    """端口范围结束值"""
+    portAssignInterval: int
     """未知"""
+    port: int
+    """节点监听端口"""
 
 
-class DaemonModel(BaseModel):
-    """节点详细信息"""
+class DaemonSystemInfo(BaseModel):
+    """节点系统信息"""
 
-    version: str
+    version: str | None = None
     """远程节点版本"""
-    process: ProcessInfo
+    process: ProcessInfo | None = None
     """远程节点的基本信息"""
-    instance: InstanceInfo
+    instance: InstanceStat | None = None
     """远程节点实例基本信息"""
-    system: DaemonSystemInfo
+    system: SystemInfo | None = None
     """远程节点系统信息"""
-    cpuMemChart: list[CpuMemChart]
+    cpuMemChart: list[CpuMemChart] | None = None
     """cpu和内存使用趋势"""
+    config: DaemonSetting
+    """节点系统配置信息"""
+
+
+class DaemonOperation(BaseModel):
     uuid: str
-    """远程节点的uuid"""
-    ip: str
-    """远程节点的ip"""
-    port: int
-    """远程节点的端口"""
-    prefix: str
-    """远程节点的路径前缀"""
-    available: bool
-    """远程节点的可用状态"""
-    remarks: str
-    """远程节点的名称"""
+    """节点UUID"""
 
     def delete(self):
         """
         删除该节点
 
-        :returns: 删除成功后返回True
+        :returns: 操作成功后返回True
         """
         from mcsmapi.apis.daemon import Daemon
 
@@ -75,7 +85,7 @@ class DaemonModel(BaseModel):
         """
         尝试连接该节点
 
-        :returns: 连接成功后返回True
+        :returns: 操作成功后返回True
         """
         from mcsmapi.apis.daemon import Daemon
 
@@ -87,20 +97,14 @@ class DaemonModel(BaseModel):
 
         :params config: 节点的配置信息，以字典形式提供，缺失内容使用原节点配置填充
 
-        :returns: 更新成功后返回True
+        :returns: 操作成功后返回True
         """
         from mcsmapi.apis.daemon import Daemon
 
         updated_config = self.model_dump()
         updated_config.update(config)
-        # 过滤节点配置中不需要的字段
-        daemon_config_dict = {
-            key: updated_config[key]
-            for key in DaemonConfig.model_fields.keys()
-            if key in updated_config
-        }
 
-        daemon_config = DaemonConfig(**daemon_config_dict).model_dump()
+        daemon_config = DaemonUpdateConfig(**updated_config).model_dump()
 
         return Daemon.update(self.uuid, daemon_config)
 
@@ -140,7 +144,36 @@ class DaemonConfig(BaseModel):
     """远程节点的端口"""
     prefix: str = ""
     """远程节点的路径前缀"""
-    remarks: str = "New Daemon"
+    remarks: str = "Unnamed Node"
     """远程节点的备注"""
-    available: bool = True
-    """远程节点的可用状态"""
+    apiKey: str = ""
+    """远程节点的apiKey"""
+
+
+class DaemonStatus(DaemonOperation):
+    """节点状态信息"""
+
+    ip: str = "localhost"
+    """远程节点的ip"""
+    port: int = 24444
+    """远程节点的端口"""
+    prefix: str = ""
+    """远程节点的路径前缀"""
+    remarks: str = "Unnamed Node"
+    """远程节点的备注"""
+    available: bool
+    """节点可用状态"""
+
+
+class DaemonInfo(DaemonStatus):
+    """节点信息"""
+
+    instances: list[InstanceDetail]
+    """节点实例列表"""
+
+
+class DaemonUpdateConfig(DaemonConfig):
+    """节点更新配置信息"""
+
+    setting: DaemonSetting
+    """节点系统配置"""

mcsmapi/models/file.py

@@ -1,10 +1,12 @@
 from enum import IntEnum
-from typing import Literal
-from pydantic import BaseModel
+from typing import Any, Literal
+from pydantic import BaseModel, field_validator
 import os
 
 
 class FileType(IntEnum):
+    """文件类型"""
+
     FOLDER = 0
     FILE = 1
 
@@ -13,7 +15,7 @@ class FileItem(BaseModel):
     """文件信息"""
 
     name: str
-    """文件名称"""
+    """文件或文件夹名称"""
     size: int
     """文件大小(单位: byte)"""
     time: str
@@ -37,7 +39,7 @@ class FileItem(BaseModel):
 
         :params new_name: 源文件或文件夹的新名字
 
-        :returns: 重命名成功后返回True
+        :returns: 操作成功后返回True
         """
         from mcsmapi.apis.file import File
 
@@ -49,7 +51,7 @@ class FileItem(BaseModel):
         """
         删除该文件或文件夹
 
-        :returns: 重命名成功后返回True
+        :returns: 操作成功后返回True
         """
         from mcsmapi.apis.file import File
 
@@ -57,13 +59,13 @@ class FileItem(BaseModel):
             self.daemonId, self.uuid, [os.path.join(self.target, self.name)]
         )
 
-    def copy(self, target: str):
+    def copy2(self, target: str):
         """
         复制该文件或文件夹到目标路径
 
         :param target: 目标路径
 
-        :returns: 复制成功后返回True
+        :returns: 操作成功后返回True
         """
         from mcsmapi.apis.file import File
 
@@ -77,7 +79,7 @@ class FileItem(BaseModel):
 
         :params target: 目标文件或文件夹的路径
 
-        :returns: 移动成功后返回True
+        :returns: 操作成功后返回True
         """
         from mcsmapi.apis.file import File
 
@@ -99,13 +101,11 @@ class FileItem(BaseModel):
 
     def zip(self, targets: list[str]):
         """
-        压缩多个文件或文件夹到指定位置
+        压缩该文件或文件夹到指定位置
 
-        **参数:**
-        - targets (list): 要压缩到的目标文件的路径
+        :params targets: 要压缩到的目标文件的路径
 
-        **返回:**
-        - bool: 压缩成功后返回True
+        :returns: 操作成功后返回True
         """
         from mcsmapi.apis.file import File
 
@@ -113,19 +113,14 @@ class FileItem(BaseModel):
             self.daemonId, self.uuid, os.path.join(self.target, self.name), targets
         )
 
-    def unzip(
-        self, target: str, code: Literal["utf-8", "gbk", "big5"] = "utf-8"
-    ) -> bool:
+    def unzip(self, target: str, code: Literal["utf-8", "gbk", "big5"] = "utf-8"):
         """
         解压缩该 zip 文件到目标位置
 
-        **参数:**
-        - target (str): 解压到的目标路径
-        - code (str, optional): 压缩文件的编码方式，默认为"utf-8"
-            可选值: utf-8, gbk, big5
+        :params target: 解压到的目标路径
+        :params code: 压缩文件的编码方式
 
-        **返回:**
-        - bool: 解压成功后返回True
+        :returns: 操作成功后返回True
         """
         from mcsmapi.apis.file import File
 
@@ -133,13 +128,13 @@ class FileItem(BaseModel):
             self.daemonId, self.uuid, os.path.join(self.target, self.name), target, code
         )
 
-    def update(self, text: str) -> bool:
+    def update(self, text: str):
         """
         更新该文件内容
-        **参数:**
-        - text (str): 文件内容
-        **返回:**
-        - bool: 更新成功后返回True
+
+        :params text: 文件内容
+
+        :returns: 操作成功后返回True
         """
         from mcsmapi.apis.file import File
 
@@ -147,11 +142,11 @@ class FileItem(BaseModel):
             self.daemonId, self.uuid, os.path.join(self.target, self.name), text
         )
 
-    def download(self) -> str:
+    def download(self):
         """
         下载该文件
-        **返回:**
-        - str: 文件下载的URL
+
+        :returns: 文件下载的URL
         """
         from mcsmapi.apis.file import File
 
@@ -180,23 +175,30 @@ class FileList(BaseModel):
     target: str
     """文件（名称或目录）路径"""
 
-    def __init__(self, **data: str):
-        super().__init__(**data)
-        for item in self.items:
-            item.daemonId = self.daemonId
-            item.uuid = self.uuid
-            item.target = self.target
+    @field_validator("items", mode="before")
+    @classmethod
+    def fill_info(cls, v: Any, info) -> Any:
+        """在验证 items 字段前填充基本信息"""
+        if isinstance(info.data, dict):
+            daemon_id = info.data.get("daemonId", "")
+            uuid = info.data.get("uuid", "")
+            target = info.data.get("target", "")
+            if isinstance(v, list):
+                for item in v:
+                    if isinstance(item, dict):
+                        item["daemonId"] = daemon_id
+                        item["uuid"] = uuid
+                        item["target"] = target
+        return v
 
     async def upload(self, file: bytes, upload_dir: str) -> bool:
         """
         上传文件到实例
 
-        **参数:**
-        - file (bytes): 要上传的文件内容
-        - upload_dir (str): 上传文件的目标目录(包含文件名)
+        :params file: 要上传的文件内容
+        :params upload_dir: 文件上传到的目标路径
 
-        **返回:**
-        - bool: 操作成功返回True
+        :returns: 操作成功返回True
         """
         from mcsmapi.apis.file import File
 
@@ -206,11 +208,9 @@ class FileList(BaseModel):
         """
         创建文件
 
-        **参数:**
-        - target (str): 目标文件的路径，包含文件名
+        :params target: 目标文件的路径，包含文件名
 
-        **返回:**
-        - bool: 创建成功后返回True
+        :returns: 操作成功后返回True
         """
         from mcsmapi.apis.file import File
 
@@ -220,11 +220,9 @@ class FileList(BaseModel):
         """
         创建文件夹
 
-        **参数:**
-        - target (str): 目标文件夹的路径
+        :params target: 目标文件夹的路径
 
-        **返回:**
-        - bool: 创建成功后返回True
+        :returns: 操作成功后返回True
         """
         from mcsmapi.apis.file import File
 

mcsmapi/models/instance.py

@@ -1,6 +1,6 @@
 from enum import IntEnum
 from typing import Any, TypedDict
-from pydantic import BaseModel
+from pydantic import BaseModel, field_validator
 from mcsmapi.models.image import DockerConfig
 
 
@@ -121,55 +121,15 @@ class InstanceConfig(BaseModel):
     """运行该实例的系统用户，为空则使用启动面板的系统用户"""
 
 
-class InstanceProcessInfo(BaseModel):
-    """进程信息"""
-
-    cpu: int
-    """CPU 使用率 (单位: %)"""
-    memory: int
-    """进程占用内存 (单位: KB)"""
-    ppid: int
-    """父进程 ID"""
-    pid: int
-    """进程 ID"""
-    ctime: int
-    """进程创建时间 (Unix 时间戳)"""
-    elapsed: int
-    """进程运行时长 (单位: 秒)"""
-    timestamp: int
-    """时间戳"""
-
-
-class InstanceInfo(BaseModel):
-    """实例运行状态信息(这些选项在新版中已不再支持设置，但仍在API中返回)"""
-
-    currentPlayers: int
-    """当前玩家数量"""
-    fileLock: int = 0
-    """文件锁状态 (0: 无锁)"""
-    maxPlayers: int = -1
-    """最大允许玩家数 (-1 表示未知)"""
-    openFrpStatus: bool = False
-    """是否启用 FRP 远程服务"""
-    playersChart: list[dict] = []
-    """玩家数量变化图表数据"""
-    version: str = ""
-    """服务器版本"""
-
-
 class InstanceDetail(BaseModel):
     """实例详细信息"""
 
     config: InstanceConfig
     """实例的配置信息"""
-    info: InstanceInfo
-    """实例的运行状态信息"""
     daemonId: str
     """所属的节点UUID"""
     instanceUuid: str
     """实例UUID"""
-    processInfo: InstanceProcessInfo
-    """实例的进程信息"""
     started: int
     """实例的启动次数"""
     status: Status
@@ -179,7 +139,7 @@ class InstanceDetail(BaseModel):
         """
         启动该实例
 
-        :returns: 返回被操作的实例的UUID
+        :returns: 被启动的实例的UUID
         """
         from mcsmapi.apis.instance import Instance
 
@@ -189,7 +149,7 @@ class InstanceDetail(BaseModel):
         """
         停止该实例
 
-        :returns: 返回被操作的实例的UUID
+        :returns: 被停止的实例的UUID
         """
         from mcsmapi.apis.instance import Instance
 
@@ -199,7 +159,7 @@ class InstanceDetail(BaseModel):
         """
         重启该实例
 
-        :returns: 返回被操作的实例的UUID
+        :returns: 被重启的实例的UUID
         """
         from mcsmapi.apis.instance import Instance
 
@@ -209,16 +169,18 @@ class InstanceDetail(BaseModel):
         """
         强制关闭该实例
 
-        :returns: 返回被操作的实例的UUID
+        :returns: 被强制关闭的实例的UUID
         """
         from mcsmapi.apis.instance import Instance
 
         return Instance.kill(self.daemonId, self.instanceUuid)
 
-    def delete(self, deleteFile=False):
+    def delete(self, deleteFile: bool = False):
         """
         删除该实例
 
+        :params deleteFile: 是否删除关联的文件
+
         :returns: 被删除的实例的uuid
         """
         from mcsmapi.apis.instance import Instance
@@ -268,6 +230,30 @@ class InstanceDetail(BaseModel):
             self.daemonId, self.instanceUuid, targetUrl, title, description
         )
 
+    def command(self, command: str) -> str:
+        """
+        发送命令给实例
+
+        :params command: 要发送的命令
+
+        :returns: 被操作的实例的UUID
+        """
+        from mcsmapi.apis.instance import Instance
+
+        return Instance.command(self.daemonId, self.instanceUuid, command)
+
+    def get_output(self, size: int | None = None) -> str:
+        """
+        获取实例的输出
+
+        :params size: 要获取的输出大小
+
+        :returns: 输出结果
+        """
+        from mcsmapi.apis.instance import Instance
+
+        return Instance.get_output(self.daemonId, self.instanceUuid, size)
+
     def files(
         self, target: str = "", page: int = 0, page_size: int = 100, file_name: str = ""
     ):
@@ -291,9 +277,9 @@ class InstanceDetail(BaseModel):
 class InstanceCreateResult(BaseModel):
     """实例创建结果"""
 
-    instanceUuid: str = ""
+    instanceUuid: str
     """实例UUID"""
-    config: InstanceConfig = InstanceConfig()
+    config: InstanceConfig
     """实例的配置信息"""
 
 
@@ -309,17 +295,14 @@ class InstanceSearchList(BaseModel):
     daemonId: str = ""
     """所属的节点UUID"""
 
-    def __init__(self, **data: str):
-        """实例化对象，并在每个实例中填充 daemonId"""
-        super().__init__(**data)
-        for instance in self.data:
-            instance.daemonId = self.daemonId
-
-
-class UserInstancesList(BaseModel):
-    """用户实例列表"""
-
-    instanceUuid: str = ""
-    """实例UUID"""
-    daemonId: str = ""
-    """所属的节点UUID"""
+    @field_validator("data", mode="before")
+    @classmethod
+    def fill_daemon_id(cls, v: Any, info) -> Any:
+        """在验证 data 字段前填充 daemonId"""
+        if isinstance(info.data, dict):
+            daemon_id = info.data.get("daemonId", "")
+            if isinstance(v, list):
+                for instance in v:
+                    if isinstance(instance, dict):
+                        instance["daemonId"] = daemon_id
+        return v

mcsmapi/models/overview.py

@@ -2,7 +2,7 @@ from enum import Enum
 from typing import Literal
 from pydantic import BaseModel
 from mcsmapi.models.common import CpuMemChart, ProcessInfo
-from mcsmapi.models.daemon import DaemonModel
+from mcsmapi.models.daemon import DaemonSystemInfo
 
 
 class SystemUser(BaseModel):
@@ -110,7 +110,7 @@ class OverviewModel(BaseModel):
     """系统与请求统计图表数据"""
     remoteCount: RemoteCountInfo
     """远程节点统计信息"""
-    remote: list[DaemonModel]
+    remote: list[DaemonSystemInfo]
     """远程节点详细信息"""
 
 

mcsmapi/models/user.py

@@ -1,7 +1,6 @@
 from enum import IntEnum
 from typing import Any
 from pydantic import BaseModel
-from mcsmapi.models.instance import InstanceDetail, UserInstancesList
 
 
 class UserPermission(IntEnum):
@@ -12,6 +11,15 @@ class UserPermission(IntEnum):
     ADMIN = 10
 
 
+class UserInstances(BaseModel):
+    """用户实例信息"""
+
+    instanceUuid: str
+    """实例UUID"""
+    daemonId: str
+    """节点ID"""
+
+
 class UserCreateResult(BaseModel):
     """用户创建结果"""
 
@@ -26,38 +34,38 @@ class UserCreateResult(BaseModel):
 class UserModel(BaseModel):
     """用户信息模型"""
 
-    uuid: str
+    uuid: str = ""
     """用户UUID"""
-    userName: str
+    userName: str = ""
     """用户名"""
-    permission: UserPermission
+    loginTime: str = ""
+    """最后登录时间 (YYYY/M/D hh:mm:ss)"""
+    registerTime: str = ""
+    """注册时间 (YYYY/M/D hh:mm:ss)"""
+    instances: list[UserInstances] = []
+    """用户拥有的实例列表"""
+    permission: UserPermission = UserPermission.USER
     """用户权限级别"""
-    registerTime: str
-    """用户注册时间 (YYYY/M/D hh:mm:ss)"""
-    loginTime: str
-    """用户最后登录时间 (YYYY/M/D hh:mm:ss)"""
-    apiKey: str
-    """用户 API 密钥"""
-    open2FA: bool
+    passWord: str = ""
+    """用户密码"""
+    open2FA: bool = False
     """是否启用双因素认证 (2FA)"""
-    instances: list[UserInstancesList]
-    """用户关联的实例列表"""
-    isInit: bool
+    apiKey: str = ""
+    """用户 API 密钥"""
+    passWordType: int = 1
+    """密码类型 (已弃用)"""
+    isInit: bool = False
     """是否为初始化用户 (已弃用)"""
-    secret: str
+    secret: str = ""
     """用户安全密钥 (已弃用)"""
-    passWord: str
-    """用户密码 (已弃用)"""
-    passWordType: int
-    """密码类型 (已弃用)"""
-    salt: str
-    """密码盐值 (已弃用)"""
+    salt: str = ""
+    """用户密码盐值 (已弃用)"""
 
     def delete(self):
         """
         删除该用户
 
-        :returns: 删除成功后返回True
+        :returns: 操作成功后返回True
         """
         from mcsmapi.apis.user import User
 
@@ -69,20 +77,12 @@ class UserModel(BaseModel):
 
         :params config: 用户的新信息，以字典形式提供，缺失内容使用原用户信息填充
 
-        :returns: 更新成功后返回True
+        :returns: 操作成功后返回True
         """
         from mcsmapi.apis.user import User
 
-        updated_config = self.model_dump()
-        updated_config.update(config)
-        # 过滤用户信息中不需要的字段
-        user_config_dict = {
-            key: updated_config[key]
-            for key in UserConfig.model_fields.keys()
-            if key in updated_config
-        }
-
-        user_config = UserConfig(**user_config_dict).model_dump()
+        user_config = self.model_dump()
+        user_config.update(config)
 
         return User().update(self.uuid, user_config)
 
@@ -100,34 +100,3 @@ class SearchUserModel(BaseModel):
     """最大可用页数"""
     data: list[UserModel]
     """用户信息列表"""
-
-
-class UserConfig(BaseModel):
-    """用户配置信息"""
-
-    uuid: str = ""
-    """用户UUID"""
-    userName: str = ""
-    """用户名"""
-    loginTime: str = ""
-    """最后登录时间"""
-    registerTime: str = ""
-    """注册时间"""
-    instances: list[InstanceDetail] = []
-    """用户拥有的实例列表"""
-    permission: UserPermission = UserPermission.USER
-    """用户权限级别"""
-    passWord: str = ""
-    """用户密码"""
-    open2FA: bool = False
-    """是否启用双因素认证 (2FA)"""
-    apiKey: str = ""
-    """用户 API 密钥"""
-    passWordType: int = 1
-    """密码类型 (已弃用)"""
-    isInit: bool = False
-    """是否为初始化用户 (已弃用)"""
-    secret: str = ""
-    """用户安全密钥 (已弃用)"""
-    salt: str = ""
-    """用户密码盐值 (已弃用)"""

{mcsmapi-0.1.8b1.dist-info → mcsmapi-0.1.8b3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mcsmapi
-Version: 0.1.8b1
+Version: 0.1.8b3
 Summary: Shortcut the pypi package of MCSM./快捷操作MCSM的pypi包
 Author-email: molanp <molanpp@outlook.com>
 License-Expression: MIT
@@ -32,7 +32,7 @@ The documentation is not yet complete, if you need it, please visit [deepwiki-mc
 
 You can also find:  
 
-📄 Work-in-progress docs: [docs](docs)
+📄 Docs: [docs](https://mcsmapi.awkchan.top/en/)
 
 💡 Example: [example](example)
 
@@ -50,7 +50,7 @@ You can install `mcsmapi` using `pip`:
 pip install mcsmapi
 ```
 
-If you need the latest build files (untested), please visit
+If you need the latest build files, please visit
 [Actions](https://github.com/molanp/mcsmapi/actions/workflows/auto-build.yml)
 
 ## Supported Features

mcsmapi-0.1.8b3.dist-info/RECORD

@@ -0,0 +1,24 @@
+mcsmapi/__init__.py,sha256=e5rSZDGOeaq-Wky85uQokqDBMt-v7Ktp6GTH0PVRUkc,1339
+mcsmapi/exceptions.py,sha256=mHsAHyoX9SiFDGBMEhesA_ao9hhZZ38EGTp97K7VDp8,184
+mcsmapi/pool.py,sha256=Xa1DvBdfn5zTZ-eB50BFbYxhKX8j-4vfus9QOGO_FQE,348
+mcsmapi/request.py,sha256=G6O4Q3oXidmauyraUgoMTkms5XFlY-iHPhZ3s0k9TmM,2743
+mcsmapi/apis/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+mcsmapi/apis/daemon.py,sha256=fdoZIuS-8Hm9YS3YeCDmxJwOFGp4KaqnHlwQum2JBRU,2827
+mcsmapi/apis/file.py,sha256=pCjZUl5W6F8Y0WBhRf0dsefnNqX8pKpXGehCwYM-8N0,9610
+mcsmapi/apis/image.py,sha256=JcRESUz9j6kozWT7XAr-PoVIyoDvl55OSdjYB33yFpw,2650
+mcsmapi/apis/instance.py,sha256=Ttu7Ww5C7FOdUNrl5VBWjWhr_lMuRnjvbqHgg1BjntE,8297
+mcsmapi/apis/overview.py,sha256=7wRAdhFzbtLq6Oknj4_ncO5fETZuZCGtliErA0NNju0,514
+mcsmapi/apis/user.py,sha256=8wB-WcOzSgLmootmlDAebuShK97Bo1Jb2GMyChyjTrA,2411
+mcsmapi/models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+mcsmapi/models/common.py,sha256=SoJt0fFab9hCzWI8ubQDPyep9YCXmny4bCy9utFNW9o,531
+mcsmapi/models/daemon.py,sha256=9zkUG7M4KYFwz7pSFJjAIZSkLGpHMcOKq20RHxseHQI,4813
+mcsmapi/models/file.py,sha256=w7KVUauGGp6w1BVm9QlR6kM0hBZJ12wLVkqRvNS-HJ8,6031
+mcsmapi/models/image.py,sha256=mpyS7KTVoOwH2opB-fQC2GD3An_bXcERLmLPDBuoYUA,5643
+mcsmapi/models/instance.py,sha256=p4zbRxbYHhQrZUlTMulVeiH4TfVsB11dCOs_GQltxPo,8050
+mcsmapi/models/overview.py,sha256=2mytJbI6mivNqytIjd8ddkgL4wJcADa2HrTVeqlrkFI,5294
+mcsmapi/models/user.py,sha256=3Lnr5ayHJH4cuWRx4ENW7NzHYYu7U-jnST9iWLZR-54,2339
+mcsmapi-0.1.8b3.dist-info/licenses/LICENSE,sha256=bMKDPsvaybvY-4TTlSZtCXPPtxb7KPpDVqXgDA8Ogo0,1068
+mcsmapi-0.1.8b3.dist-info/METADATA,sha256=G1rqn4oI0QX0ZRoqYlK0YWnaIDptuyI1BStDEoMaUhg,3031
+mcsmapi-0.1.8b3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+mcsmapi-0.1.8b3.dist-info/top_level.txt,sha256=8MUYHd1Or4cbSCd93IaqLA72w0weEuKieopVwIfVlWo,8
+mcsmapi-0.1.8b3.dist-info/RECORD,,

mcsmapi-0.1.8b1.dist-info/RECORD

@@ -1,24 +0,0 @@
-mcsmapi/__init__.py,sha256=TxBjQPMtwR_Eh0N7nZAoKinONAgnDsSbt47-cLvbeLk,1418
-mcsmapi/exceptions.py,sha256=mHsAHyoX9SiFDGBMEhesA_ao9hhZZ38EGTp97K7VDp8,184
-mcsmapi/pool.py,sha256=Xa1DvBdfn5zTZ-eB50BFbYxhKX8j-4vfus9QOGO_FQE,348
-mcsmapi/request.py,sha256=G6O4Q3oXidmauyraUgoMTkms5XFlY-iHPhZ3s0k9TmM,2743
-mcsmapi/apis/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-mcsmapi/apis/daemon.py,sha256=0ng7Twv04gs4y09AYFIH2o5YPoxGV3c3TwsUkqxpgTI,2555
-mcsmapi/apis/file.py,sha256=1SYNw-6Qaiq5knS0Pu1_7-y82WtcB6EOHPGakYvvqjQ,9630
-mcsmapi/apis/image.py,sha256=ajTiZXSj0o5aMEDcPe6JkFI5JJcYZhQXszmNqnbSJxA,2656
-mcsmapi/apis/instance.py,sha256=h2y3gTLINvDZq7vOzBhQ3X02f3mmg5ZlPunMDkTahgo,8318
-mcsmapi/apis/overview.py,sha256=7wRAdhFzbtLq6Oknj4_ncO5fETZuZCGtliErA0NNju0,514
-mcsmapi/apis/user.py,sha256=KXd8OPjyQBprPTlJD-wLGE-BtaOsM_0WF1yqRlGgTfg,2414
-mcsmapi/models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-mcsmapi/models/common.py,sha256=HNvYJnbxrtkJ7-H2zCXSuB-J-YXBXCcfyK0TzQprsKI,531
-mcsmapi/models/daemon.py,sha256=It7kPyxogqY6oBdyXYNi4EmyqlGwizu7j-N37snko8k,4093
-mcsmapi/models/file.py,sha256=vk9rQp3Yw_aK7F8ghi5eiBYuwcjK1m-2IQ0YbUWoj3A,5933
-mcsmapi/models/image.py,sha256=mpyS7KTVoOwH2opB-fQC2GD3An_bXcERLmLPDBuoYUA,5643
-mcsmapi/models/instance.py,sha256=FTFLkwi3r9OUQnusIQ1JI1f7dX4QIbH1Q5BxfUWIqxM,8362
-mcsmapi/models/overview.py,sha256=Q_MG04iCkQ7KdBZnji3xA9XzwM3JZ6fZe3NWap8lMdU,5284
-mcsmapi/models/user.py,sha256=f2fZS1EQFwqOJM7fKu91dcvHHAdRjhAhwY8XfwXhRvk,3318
-mcsmapi-0.1.8b1.dist-info/licenses/LICENSE,sha256=bMKDPsvaybvY-4TTlSZtCXPPtxb7KPpDVqXgDA8Ogo0,1068
-mcsmapi-0.1.8b1.dist-info/METADATA,sha256=FyYvDSMJwqwYImKbLTXSSNx4f7mI_LFb9EqxOITuWVs,3032
-mcsmapi-0.1.8b1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-mcsmapi-0.1.8b1.dist-info/top_level.txt,sha256=8MUYHd1Or4cbSCd93IaqLA72w0weEuKieopVwIfVlWo,8
-mcsmapi-0.1.8b1.dist-info/RECORD,,