mcsmapi 0.1.5b1__py3-none-any.whl → 0.1.5b2__py3-none-any.whl

mcsmapi/apis/daemon.py

@@ -1,10 +1,63 @@
 from typing import Any
 from mcsmapi.pool import ApiPool
 from mcsmapi.request import send
-from mcsmapi.models.daemon import DaemonConfig
+from mcsmapi.models.daemon import DaemonConfig, DaemonModel
+from mcsmapi.models.daemon.instance import InstanceDetail
 
 
 class Daemon:
+    def show(self) -> list[DaemonConfig]:
+        """
+        获取全部节点配置信息
+
+        返回:
+        - List[DaemonConfig]: 节点的配置信息列表
+        """
+        daemons = send(
+            "GET",
+            f"{ApiPool.SERVICE}/remote_services_list",
+        )
+        return [DaemonConfig(**daemon) for daemon in daemons]
+        
+    def system(self) -> list[DaemonModel]:
+        """
+        获取全部节点的系统信息
+        
+        返回:
+        - List[DaemonModel]: 节点系统信息列表
+        """
+        daemons = send(
+            "GET",
+            f"{ApiPool.SERVICE}/remote_services_system",
+        )
+        return [DaemonModel(**daemon) for daemon in daemons]
+    
+    def instances(self, daemonId: str, page: int = 0, page_size: int = 10, instance_name: str = "", status: int = 0, tag: list[str] | None = None) -> list[InstanceDetail]:
+        """
+        查询指定节点下的实例详细信息
+        
+        参数:
+        - `daemonId` (str): 要查询的守护进程（Daemon）的唯一标识符。
+        - `page` (int, 默认=0): 分页查询的页码（从 0 开始）。
+        - `page_size` (int, 默认=10): 每页返回的实例数量。
+        - `instance_name` (str, 默认=""): 过滤指定名称的实例。
+        - `status` (int, 默认=0): 过滤指定状态的实例，如运行中、已停止等。
+        - `tag` (List[str] | None, 默认=None): 根据标签筛选实例（可选参数）。
+      
+        返回:
+        - `List[InstanceDetail]`: 包含实例详细信息的列表。
+      
+        注意:
+        - 此方法尚未实现 (`raise RuntimeError`)，因为 MCSM 官方文档未提供足够的信息。
+        - 由于根据 MCSM 源代码的测试无法获取有效数据，目前无法完成该功能的开发。
+        - 如果你有具体的实现思路，请在 issue 中提出
+        - 可供参考 MCSM 源码: [daemon_router.ts 第 32 行](https://github.com/MCSManager/MCSManager/blob/master/panel%2Fsrc%2Fapp%2Frouters%2Fdaemon_router.ts#L32-L32)
+        - 模型定义代码: https://github.com/MCSManager/MCSManager/blob/master/frontend%2Fsrc%2Fservices%2Fapis%2Findex.ts#L86-L86
+        - 测试地址示例:
+            `http://localhost:23333/api/service/remote_service_instances?apikey=xxx&daemonId=xxx&page=0&page_size=10&status=3&instance_name=`
+        """
+        raise RuntimeError("此方法尚未实现")
+
     def add(self, config: dict[str, Any]) -> str:
         """
         新增一个节点。

mcsmapi/apis/file.py

@@ -13,6 +13,7 @@ class File:
         target: str = "",
         page: int = 0,
         page_size: int = 100,
+        file_name: str = ""
     ) -> FileList:
         """
         获取文件列表
@@ -23,6 +24,7 @@ class File:
         - target (str, 可选): 用于文件过滤的目标路径。默认为空字符串，表示不按路径过滤。
         - page (int, 可选): 指定分页的页码。默认为0。
         - page_size (int, 可选): 指定每页的文件数量。默认为100。
+        - file_name (str, 可选): 用于在文件列表中过滤出名称包含指定字符串的文件或文件夹
 
         **返回:**
         - FileList: 包含文件列表信息和分页详情的FileList模型。
@@ -36,6 +38,7 @@ class File:
                 "target": target,
                 "page": page,
                 "page_size": page_size,
+                "file_name": file_name,
             },
         )
         return FileList(**result, daemonId=daemonId, uuid=uuid)
@@ -223,8 +226,8 @@ class File:
         **参数:**
         - daemonId (str): 守护进程的唯一标识符。
         - uuid (str): 实例的唯一标识符。
-        - source (str): 需要压缩到的 zip 文件路径。
-        - targets (list): 要压缩的目标文件或文件夹的路径。
+        - source (str): 需要压缩的文件路径。
+        - targets (list): 要压缩到的目标文件的路径。
 
         **返回:**
         - bool: 压缩成功后返回True。

mcsmapi/models/daemon.py

@@ -4,48 +4,89 @@ from mcsmapi.models.instance import InstanceCreateResult
 
 
 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:
@@ -127,8 +168,15 @@ class DaemonModel(BaseModel):
 
 
 class DaemonConfig(BaseModel):
+    """节点配置信息"""
+
+    """远程节点的ip"""
     ip: str = "localhost"
+    """远程节点的端口"""
     port: int = 24444
+    """远程节点的路径前缀"""
     prefix: str = ""
+    """远程节点的备注"""
     remarks: str = "New Daemon"
+    """远程节点的可用状态"""
     available: bool = True

mcsmapi/models/file.py

@@ -4,14 +4,26 @@ import os
 
 
 class FileItem(BaseModel):
-    name: str = "New File"
+    """文件信息"""
+
+    """文件名称"""
+    name: str = ""
+    """文件大小(单位: 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:
         """
@@ -65,6 +77,34 @@ class FileItem(BaseModel):
             self.daemonId, self.uuid, os.path.join(self.target, self.name), target
         )
 
+    def content(self):
+        """
+        获取文件内容。
+        **返回:**
+        - str | bytes: 文件内容。
+        """
+        from mcsmapi.apis.file import File
+
+        return File().content(
+            self.daemonId, self.uuid, os.path.join(self.target, self.name)
+        )
+
+    def zip(self, targets: list[str]) -> bool:
+        """
+        压缩多个文件或文件夹到指定位置。
+
+        **参数:**
+        - targets (list): 要压缩到的目标文件的路径。
+
+        **返回:**
+        - bool: 压缩成功后返回True。
+        """
+        from mcsmapi.apis.file import File
+
+        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:
         """
         解压缩该 zip 文件到目标位置。
@@ -83,15 +123,51 @@ class FileItem(BaseModel):
             self.daemonId, self.uuid, os.path.join(self.target, self.name), target, code
         )
 
+    def update(self, text: str) -> bool:
+        """
+        更新该文件内容。
+        **参数:**
+        - text (str): 文件内容。
+        **返回:**
+        - bool: 更新成功后返回True。
+        """
+        from mcsmapi.apis.file import File
+
+        return File().update(
+            self.daemonId, self.uuid, os.path.join(self.target, self.name), text
+        )
+
+    def download(self) -> str:
+        """
+        下载该文件。
+        **返回:**
+        - str: 文件下载的URL。
+        """
+        from mcsmapi.apis.file import File
+
+        return File().download(
+            self.daemonId, self.uuid, os.path.join(self.target, self.name)
+        )
+
 
 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):
@@ -101,8 +177,52 @@ class FileList(BaseModel):
             item.uuid = self.uuid
             item.target = self.target
 
+    async def upload(self, file: bytes, upload_dir: str) -> bool:
+        """
+        上传文件到实例。
+
+        **参数:**
+        - file (bytes): 要上传的文件内容。
+        - upload_dir (str): 上传文件的目标目录(包含文件名)。
+
+        **返回:**
+        - bool: 返回操作结果，成功时返回True。
+        """
+        from mcsmapi.apis.file import File
+
+        return await File().upload(self.daemonId, self.uuid, file, upload_dir)
+
+    def createFile(self, target: str) -> bool:
+        """
+        创建文件。
+
+        **参数:**
+        - target (str): 目标文件的路径，包含文件名。
+
+        **返回:**
+        - bool: 创建成功后返回True。
+        """
+        from mcsmapi.apis.file import File
+
+        return File().createFile(self.daemonId, self.uuid, target)
+
+    def createFloder(self, target: str) -> bool:
+        """
+        创建文件夹
+
+        **参数:**
+        - target (str): 目标文件夹的路径。
+
+        **返回:**
+        - bool: 创建成功后返回True。
+        """
+        from mcsmapi.apis.file import File
+
+        return File().createFloder(self.daemonId, self.uuid, target)
 
 
 class CommonConfig(BaseModel):
+    """文件下载密码"""
     password: str = ""
+    """文件下载地址"""
     addr: str = ""

mcsmapi/models/image.py

@@ -3,110 +3,205 @@ from pydantic import BaseModel
 
 
 class DockerConfig(BaseModel):
+    """容器配置"""
+
+    """容器名称"""
     containerName: str = ""
-    image: str = "mcsm-ubuntu:22.04"
-    memory: int = 1024  # in MB
-    ports: List[str] = ["25565:25565/tcp"]
+    """镜像名称"""
+    image: str = ""
+    """容器分配内存(单位: MB)"""
+    memory: int = 0  # in MB
+    """容器端口映射"""
+    ports: List[str] = []  # ["25565:25565/tcp"]
+    """额外挂载卷路径"""
     extraVolumes: List[str] = []
+    """容器可使用的最大磁盘空间(单位: MB)"""
     maxSpace: Optional[int] = None
+    """网络配置，可以是网络名称或ID"""
     network: Optional[Union[str, int]] = None
+    """容器的 IO 限制"""
     io: Optional[Union[str, int]] = None
+    """网络模式(例如: bridge, host)"""
     networkMode: str = "bridge"
+    """网络别名列表"""
     networkAliases: List[str] = []
-    cpusetCpus: str = ""
+    """绑定的 CPU 核心"""
+    cpusetCpus: str = ""  # 例如 `0,1`
+    """CPU 使用率(单位: %)"""
     cpuUsage: int = 100
+    """工作目录"""
     workingDir: str = ""
+    """环境变量设置"""
     env: List[str] = []
 
 
 class DockerImageItem(BaseModel):
+    """Docker 镜像信息"""
+
+    """镜像唯一 ID"""
     Id: str = ""
+    """父镜像 ID"""
     ParentId: str = ""
-    RepoTags: List[str] = []
+    """镜像仓库标签"""
+    RepoTags: List[str] = []  # 例如 ["ubuntu:latest"]
+    """镜像摘要"""
     RepoDigests: List[str] = []
+    """镜像创建时间(Unix 时间戳)"""
     Created: int = 0
+    """镜像大小(单位: 字节)"""
     Size: int = 0
+    """镜像的虚拟大小"""
     VirtualSize: int = 0
+    """共享存储空间大小"""
     SharedSize: int = 0
+    """镜像标签"""
     Labels: dict[str, str] = {}
+    """依赖该镜像运行的容器数量"""
     Containers: int = 0
 
 
 class DockerContainerItemPort(BaseModel):
+    """Docker 容器端口映射"""
+
+    """容器内部端口"""
     PrivatePort: int = 0
+    """映射到宿主机的端口"""
     PublicPort: Optional[int] = None
+    """端口类型(tcp/udp)"""
     Type: str = ""
 
 
 class DockerContainerItemNetworkSettingsNetwork(BaseModel):
+    """Docker 容器网络设置信息"""
+
+    """网络 ID"""
     NetworkID: str = ""
+    """网络端点 ID"""
     EndpointID: str = ""
+    """网关地址"""
     Gateway: str = ""
+    """分配的 IP 地址"""
     IPAddress: str = ""
+    """IP 地址前缀长度"""
     IPPrefixLen: int = 0
+    """IPv6 网关地址"""
     IPv6Gateway: str = ""
+    """IPv6 地址"""
     GlobalIPv6Address: str = ""
+    """IPv6 地址前缀长度"""
     GlobalIPv6PrefixLen: int = 0
+    """MAC 地址"""
     MacAddress: str = ""
 
 
 class DockerContainerItemNetworkSettings(BaseModel):
+    """Docker 容器的网络配置信息"""
+
+    """容器连接的所有网络"""
     Networks: dict[str, DockerContainerItemNetworkSettingsNetwork] = {}
 
 
 class DockerContainerItemMount(BaseModel):
+    """容器挂载点信息"""
+
+    """挂载名称"""
     Name: str = ""
+    """源路径"""
     Source: str = ""
+    """目标路径"""
     Destination: str = ""
+    """驱动类型"""
     Driver: str = ""
+    """挂载模式"""
     Mode: str = ""
+    """是否允许读写"""
     RW: bool = False
+    """传播模式"""
     Propagation: str = ""
 
 
 class DockerContainerItemHostConfig(BaseModel):
+    """Docker 宿主机配置"""
+
+    """网络模式"""
     NetworkMode: str = ""
 
 
 class DockerContainerItem(BaseModel):
+    """Docker 容器详细信息"""
+
+    """容器 ID"""
     Id: str = ""
+    """容器名称列表"""
     Names: List[str] = []
+    """运行的镜像名称"""
     Image: str = ""
+    """镜像 ID"""
     ImageID: str = ""
+    """容器启动命令"""
     Command: str = ""
+    """容器创建时间(Unix 时间戳)"""
     Created: int = 0
+    """容器状态"""
     State: str = ""
+    """容器运行状态描述"""
     Status: str = ""
+    """端口映射信息"""
     Ports: List[DockerContainerItemPort] = []
+    """容器标签信息"""
     Labels: dict[str, str] = {}
+    """读写层大小(单位: 字节)"""
     SizeRw: int = 0
+    """根文件系统大小(单位: 字节)"""
     SizeRootFs: int = 0
+    """宿主机配置"""
     HostConfig: DockerContainerItemHostConfig = DockerContainerItemHostConfig()
-    NetworkSettings: DockerContainerItemNetworkSettings = (
-        DockerContainerItemNetworkSettings()
-    )
+    """容器网络配置"""
+    NetworkSettings: DockerContainerItemNetworkSettings = DockerContainerItemNetworkSettings()
+    """容器挂载信息"""
     Mounts: List[DockerContainerItemMount] = []
 
 
 class DockerNetworkItemIPAMConfig(BaseModel):
+    """Docker 网络 IPAM 配置信息"""
+
+    """子网地址"""
     Subnet: str = ""
 
 
 class DockerNetworkItemIPAM(BaseModel):
+    """Docker 网络的 IP 地址管理"""
+
+    """驱动类型"""
     Driver: str = ""
+    """IPAM 配置"""
     Config: List[DockerNetworkItemIPAMConfig] = []
 
 
 class DockerNetworkItem(BaseModel):
+    """Docker 网络详细信息"""
+
+    """网络名称"""
     Name: str = ""
+    """网络 ID"""
     Id: str = ""
+    """网络创建时间"""
     Created: str = ""
+    """网络作用范围(local/global)"""
     Scope: str = ""
+    """网络驱动类型"""
     Driver: str = ""
+    """是否启用 IPv6"""
     EnableIPv6: bool = False
+    """是否为内部网络"""
     Internal: bool = False
+    """是否可附加"""
     Attachable: bool = False
+    """是否为入口网络"""
     Ingress: bool = False
+    """IPAM 配置信息"""
     IPAM: DockerNetworkItemIPAM = DockerNetworkItemIPAM()
-    Options: dict[str, str]
-    Containers: Optional[dict[str, dict]] = {}
+    """网络选项"""
+    Options: dict[str, str] = {}
+    """连接到此网络的容器信息"""
+    Containers: Optional[dict[str, dict]] = {}

mcsmapi/models/instance.py

@@ -5,77 +5,144 @@ from mcsmapi.models.image import DockerConfig
 
 
 class TerminalOption(BaseModel):
+    """终端选项"""
+
+    """是否启用颜色输出"""
     haveColor: bool = False
+    """是否使用伪终端 (PTY)"""
     pty: bool = True
 
 
 class EventTask(BaseModel):
+    """事件任务"""
+
+    """是否自动启动"""
     autoStart: bool = False
+    """是否自动重启"""
     autoRestart: bool = True
+    """是否忽略该任务"""
     ignore: bool = False
 
 
 class PingConfig(BaseModel):
+    """服务器 Ping 配置"""
+
+    """服务器 IP 地址"""
     ip: str = ""
+    """服务器端口"""
     port: int = 25565
+    """Ping 类型 (1: 默认类型)"""
     type: int = 1
 
 
 class InstanceConfig(BaseModel):
+    """实例配置信息"""
+
+    """实例名称"""
     nickname: str = "New Name"
+    """启动命令"""
     startCommand: str = "cmd.exe"
+    """停止命令"""
     stopCommand: str = "^C"
+    """工作目录"""
     cwd: str = ""
-    ie: str = "gbk"  # 输入编码
-    oe: str = "gbk"  # 输出编码
+    """输入编码"""
+    ie: str = "gbk"
+    """输出编码"""
+    oe: str = "gbk"
+    """创建时间 (Unix 时间戳)"""
     createDatetime: int = 0
+    """最后修改时间 (Unix 时间戳)"""
     lastDatetime: int = 0
+    """实例类型 (universal, minecraft 等)"""
     type: str = "universal"
+    """实例标签"""
     tag: List[str] = []
+    """实例结束时间 (可选)"""
     endTime: Optional[int] = None
+    """文件编码"""
     fileCode: str = "gbk"
+    """进程类型 (如 docker, local)"""
     processType: str = "docker"
+    """更新命令"""
     updateCommand: str = "shutdown -s"
+    """实例可执行的操作命令列表"""
     actionCommandList: List[str] = []
+    """换行符 (0: LF, 1: CR, 2: CRLF)"""
     crlf: int = 2
+    """Docker 相关配置"""
     docker: "DockerConfig" = DockerConfig()
+    """是否启用 RCON 远程控制"""
     enableRcon: bool = True
+    """RCON 连接密码"""
     rconPassword: str = ""
+    """RCON 端口"""
     rconPort: int = 2557
+    """RCON IP 地址"""
     rconIp: str = ""
+    """终端选项配置"""
     terminalOption: TerminalOption = TerminalOption()
+    """事件任务配置"""
     eventTask: EventTask = EventTask()
+    """服务器 Ping 监测配置"""
     pingConfig: PingConfig = PingConfig()
 
 
 class ProcessInfo(BaseModel):
+    """进程信息"""
+
+    """CPU 使用率 (单位: %)"""
     cpu: int = 0
+    """进程占用内存 (单位: KB)"""
     memory: int = 0
+    """父进程 ID"""
     ppid: int = 0
+    """进程 ID"""
     pid: int = 0
+    """进程创建时间 (Unix 时间戳)"""
     ctime: int = 0
+    """进程运行时长 (单位: 秒)"""
     elapsed: int = 0
+    """时间戳"""
     timestamp: int = 0
 
 
 class InstanceInfo(BaseModel):
+    """实例运行状态信息( 这些选项在新版中已不再支持设置，但仍在API中返回)"""
+
+    """当前玩家数量 (-1 表示未知)"""
     currentPlayers: int = -1
+    """文件锁状态 (0: 无锁)"""
     fileLock: int = 0
+    """最大允许玩家数 (-1 表示未知)"""
     maxPlayers: int = -1
+    """是否启用 FRP 远程服务"""
     openFrpStatus: bool = False
+    """玩家数量变化图表数据"""
     playersChart: List[Dict] = []
+    """服务器版本"""
     version: str = ""
 
 
 class InstanceDetail(BaseModel):
+    """实例详细信息"""
+
+    """实例的配置信息"""
     config: InstanceConfig = InstanceConfig()
+    """实例的运行状态信息"""
     info: InstanceInfo = InstanceInfo()
+    """所属的守护进程 (Daemon) ID"""
     daemonId: str = ""
+    """实例唯一标识符 (UUID)"""
     instanceUuid: str = ""
+    """实例的进程信息"""
     processInfo: ProcessInfo = ProcessInfo()
-    space: int = 0
-    started: int = 0  # 启动次数
-    status: int = 0  # -1 = 忙碌, 0 = 停止, 1 = 停止中, 2 = 启动中, 3 = 运行中
+    """实例的存储空间大小(始终为`0`)"""
+    space: int = 0  # 在 MCSM 代码中，此项始终为 0，意义不明
+    """实例的启动次数"""
+    started: int = 0
+    """实例状态 (-1: 忙碌, 0: 停止, 1: 停止中, 2: 启动中, 3: 运行中)"""
+    status: int = 0
 
     def start(self) -> str | bool:
         """
@@ -182,7 +249,7 @@ class InstanceDetail(BaseModel):
             self.daemonId, self.instanceUuid, targetUrl, title, description
         )
 
-    def files(self, target:str = "", page:int=0, page_size:int=100) -> FileList:
+    def files(self, target: str = "", page: int = 0, page_size: int = 100) -> FileList:
         """
         获取实例的文件列表。
 
@@ -200,22 +267,37 @@ class InstanceDetail(BaseModel):
 
 
 class InstanceCreateResult(BaseModel):
+    """实例创建结果"""
+
+    """实例唯一标识符 (UUID)"""
     instanceUuid: str = ""
+    """实例的配置信息"""
     config: InstanceConfig = InstanceConfig()
 
 
 class InstanceSearchList(BaseModel):
+    """实例搜索列表"""
+
+    """每页的实例数量"""
     pageSize: int = 0
+    """最大页数"""
     maxPage: int = 0
+    """实例详细信息列表"""
     data: List[InstanceDetail] = []
+    """所属的守护进程 (Daemon) ID"""
     daemonId: str = ""
 
     def __init__(self, **data: str):
+        """实例化对象，并在每个实例中填充 daemonId"""
         super().__init__(**data)
         for instance in self.data:
             instance.daemonId = self.daemonId
 
 
 class UserInstancesList(BaseModel):
+    """用户实例列表"""
+
+    """实例唯一标识符 (UUID)"""
     instanceUuid: str = ""
+    """所属的守护进程 (Daemon) ID"""
     daemonId: str = ""

mcsmapi/models/overview.py

@@ -4,60 +4,109 @@ from mcsmapi.models.daemon import DaemonModel
 
 
 class SystemUser(BaseModel):
+    """系统用户信息"""
+
+    """用户 ID (UID)"""
     uid: int = 0
+    """用户组 ID (GID)"""
     gid: int = 0
+    """用户名"""
     username: str = ""
+    """用户主目录"""
     homedir: str = ""
+    """默认 Shell 解释器 (可选)"""
     shell: Optional[str] = None
 
 
 class SystemInfo(BaseModel):
+    """系统信息"""
+
+    """当前登录用户信息"""
     user: SystemUser = SystemUser()
+    """系统当前时间 (Unix 时间戳)"""
     time: int = 0
+    """系统总内存大小 (单位: 字节)"""
     totalmem: int = 0
+    """系统空闲内存大小 (单位: 字节)"""
     freemem: int = 0
+    """操作系统类型"""
     type: str = ""
+    """操作系统版本"""
     version: str = ""
+    """系统节点名称"""
     node: str = ""
+    """主机名"""
     hostname: str = ""
+    """系统负载平均值 (过去 1、5、15 分钟)"""
     loadavg: List[float] = []
+    """操作系统平台"""
     platform: str = ""
+    """系统发行版本信息"""
     release: str = ""
+    """系统运行时间 (单位: 秒)"""
     uptime: float = 0
+    """CPU 当前使用率 (单位: %)"""
     cpu: float = 0
 
 
-
 class RecordInfo(BaseModel):
+    """安全记录信息"""
+
+    """成功登录次数"""
     logined: int = 0
+    """非法访问次数"""
     illegalAccess: int = 0
+    """被封禁的 IP 数量"""
     banips: int = 0
+    """登录失败次数"""
     loginFailed: int = 0
 
 
 class ChartInfo(BaseModel):
+    """图表数据信息"""
+
+    """系统性能数据 (CPU/内存等)"""
     system: List[Dict[str, float]] = []
+    """请求统计信息 (HTTP 请求数等)"""
     request: List[Dict[str, int]] = []
 
 
 class ProcessInfo(BaseModel):
+    """进程信息"""
+
+    """CPU 使用率 (单位: %)"""
     cpu: int = 0
+    """进程占用内存 (单位: KB)"""
     memory: int = 0
+    """进程当前工作目录"""
     cwd: str = ""
 
 
 class RemoteCountInfo(BaseModel):
+    """远程守护进程统计信息"""
+
+    """远程守护进程总数"""
     total: int = 0
+    """可用的远程守护进程数量"""
     available: int = 0
 
 
 class OverviewModel(BaseModel):
+    """系统概览信息"""
+
+    """系统当前版本"""
     version: str = ""
+    """指定的守护进程 (Daemon) 版本"""
     specifiedDaemonVersion: str = ""
+    """系统信息"""
     system: SystemInfo = SystemInfo()
+    """安全访问记录"""
     record: RecordInfo = RecordInfo()
+    """进程状态信息"""
     process: ProcessInfo = ProcessInfo()
+    """系统与请求统计图表数据"""
     chart: ChartInfo = ChartInfo()
+    """远程守护进程统计信息"""
     remoteCount: RemoteCountInfo = RemoteCountInfo()
+    """远程守护进程详细信息"""
     remote: List["DaemonModel"] = []
-

mcsmapi/models/user.py

@@ -4,18 +4,33 @@ from mcsmapi.models.instance import InstanceDetail, UserInstancesList
 
 
 class UserModel(BaseModel):
+    """用户信息模型"""
+
+    """用户唯一标识符 (UUID)"""
     uuid: str = ""
+    """用户名"""
     userName: str = ""
+    """用户密码 (存储加密后的字符串)"""
     passWord: str = ""
+    """密码类型 (0=默认类型)"""
     passWordType: int = 0
+    """密码盐值 (用于加密)"""
     salt: str = ""
-    permission: int = 1  # 1=用户, 10=管理员, -1=被封禁的用户
+    """用户权限级别 (1=用户, 10=管理员, -1=被封禁的用户)"""
+    permission: int = 1
+    """用户注册时间 (时间字符串格式)"""
     registerTime: str = ""
+    """用户最后登录时间 (时间字符串格式)"""
     loginTime: str = ""
+    """用户 API 密钥"""
     apiKey: str = ""
+    """是否为初始化用户 (系统内置用户)"""
     isInit: bool = False
+    """用户安全密钥 (可能用于额外的身份验证)"""
     secret: str = ""
+    """是否启用双因素认证 (2FA)"""
     open2FA: bool = False
+    """用户关联的实例列表"""
     instances: List["UserInstancesList"] = []
 
     def delete(self) -> bool:
@@ -56,21 +71,40 @@ class UserModel(BaseModel):
 
 
 class SearchUserModel(BaseModel):
+    """用户搜索结果"""
+
+    """匹配的用户总数"""
     total: int = 0
+    """当前页码"""
     page: int = 0
+    """每页返回的用户数量"""
     page_size: int = 0
+    """最大可用页数"""
     max_page: int = 0
+    """用户信息列表"""
     data: List[UserModel] = []
 
 
 class UserConfig(BaseModel):
+    """用户配置信息"""
+
+    """用户唯一标识符 (UUID)"""
     uuid: str
+    """用户名"""
     userName: str
+    """最后登录时间"""
     loginTime: str
+    """注册时间"""
     registerTime: str
+    """用户拥有的实例列表"""
     instances: List[InstanceDetail]
-    permission: int  # 1=用户, 10=管理员, -1=被封禁的用户
+    """用户权限级别 (1=用户, 10=管理员, -1=被封禁的用户)"""
+    permission: int
+    """用户 API 密钥"""
     apiKey: str
+    """是否为初始化用户 (系统内置用户)"""
     isInit: bool
+    """用户安全密钥 (可能用于额外的身份验证)"""
     secret: str
+    """是否启用双因素认证 (2FA)"""
     open2FA: bool

{mcsmapi-0.1.5b1.dist-info → mcsmapi-0.1.5b2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mcsmapi
-Version: 0.1.5b1
+Version: 0.1.5b2
 Summary: Shortcut the pypi package of MCSM./快捷操作MCSM的pypi包
 Author-email: molanp <molanpp@outlook.com>
 License-Expression: MIT
@@ -17,6 +17,7 @@ Dynamic: license-file
 ![Supported MCSManager Versions](https://img.shields.io/badge/Supported%20MCSManager%20Versions-10.x-blue)
 ![Python Version](https://img.shields.io/badge/Python%20Version-%3E%3D3.7-blue)
 ![PyPI Downloads](https://img.shields.io/pypi/dm/mcsmapi)
+[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/molanp/mcsmapi)
 
 English|[Chinese Simplified](README_zh-cn.md)
 
@@ -41,6 +42,9 @@ You can install `mcsmapi` using `pip`:
 pip install mcsmapi
 ```
 
+If you need the latest build files (untested), please visit
+[Actions](https://github.com/molanp/mcsmapi/actions)
+
 ## Supported Features
 
 - [x] Dashboard data (`Overview`)

mcsmapi-0.1.5b2.dist-info/RECORD

@@ -0,0 +1,23 @@
+mcsmapi/__init__.py,sha256=Xm0gsQMecMZwD1of9UGOkTan25l_jqrWkG-7mg0YgF4,1514
+mcsmapi/exceptions.py,sha256=mHsAHyoX9SiFDGBMEhesA_ao9hhZZ38EGTp97K7VDp8,184
+mcsmapi/pool.py,sha256=CoOYbyECp4FoXkzwFN7WgtS3vgZtvWO8e93i18vhOEI,308
+mcsmapi/request.py,sha256=5mCzKgrh4OPFKvBo22kIDpX_D1zqCza1nglYUeGWveg,2618
+mcsmapi/apis/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+mcsmapi/apis/daemon.py,sha256=2Se5ViwaePg6_CGI9qKeI823FMF0qzlemn2yCt92SPs,4488
+mcsmapi/apis/file.py,sha256=Qh3kOtU2mj9PS2nN4s6WufZ149pM0sbkM37aG-LlY5A,10778
+mcsmapi/apis/image.py,sha256=UwVH2LPfPBEADZuoSyyiMrlEc9LL858Z3oidRPaKrvs,2908
+mcsmapi/apis/instance.py,sha256=zibACXlhsMAWW5QjvGCFO5iN0wNEVlnecdnFvLeQTUg,10986
+mcsmapi/apis/overview.py,sha256=4bS3RGSykdQ1JyBTM-I9na6v0SCijEG1CN-WxqabfUo,625
+mcsmapi/apis/user.py,sha256=CBLNWxxNfvnmzoMa1YV3Q33POitYDGyN-hRORoe2JEc,2968
+mcsmapi/models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+mcsmapi/models/daemon.py,sha256=EV0nlUe6pUETbLIoUGn2HPWoNYClIyS2ABrRA70IjQk,5079
+mcsmapi/models/file.py,sha256=m75zhMkBA7KQm-870Ph3DfE9unSlOLWgMmwdl8H-vSc,6097
+mcsmapi/models/image.py,sha256=pjwSJ79rYMuDTLlazevpjqdnnc0Mqvea9bp-BepUhio,5484
+mcsmapi/models/instance.py,sha256=oNXw0q3FDTu2bG_crWPgUtLXxM2yL7eRwo9H2RFzmDA,8850
+mcsmapi/models/overview.py,sha256=yRERCPRA3vBceKjISBClngvmKaQlo0HowC859nm15Nc,2859
+mcsmapi/models/user.py,sha256=sduOS8MWoxUfvTseK7nShuBOYzei3dEM8eP45PuIZ3g,3130
+mcsmapi-0.1.5b2.dist-info/licenses/LICENSE,sha256=bMKDPsvaybvY-4TTlSZtCXPPtxb7KPpDVqXgDA8Ogo0,1068
+mcsmapi-0.1.5b2.dist-info/METADATA,sha256=IFV6TW-2aLuZydebLlPN1mSRbzsFCtRpRAbWa7kaDlc,2805
+mcsmapi-0.1.5b2.dist-info/WHEEL,sha256=DnLRTWE75wApRYVsjgc6wsVswC54sMSJhAEd4xhDpBk,91
+mcsmapi-0.1.5b2.dist-info/top_level.txt,sha256=8MUYHd1Or4cbSCd93IaqLA72w0weEuKieopVwIfVlWo,8
+mcsmapi-0.1.5b2.dist-info/RECORD,,

mcsmapi-0.1.5b1.dist-info/RECORD

@@ -1,23 +0,0 @@
-mcsmapi/__init__.py,sha256=Xm0gsQMecMZwD1of9UGOkTan25l_jqrWkG-7mg0YgF4,1514
-mcsmapi/exceptions.py,sha256=mHsAHyoX9SiFDGBMEhesA_ao9hhZZ38EGTp97K7VDp8,184
-mcsmapi/pool.py,sha256=CoOYbyECp4FoXkzwFN7WgtS3vgZtvWO8e93i18vhOEI,308
-mcsmapi/request.py,sha256=5mCzKgrh4OPFKvBo22kIDpX_D1zqCza1nglYUeGWveg,2618
-mcsmapi/apis/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-mcsmapi/apis/daemon.py,sha256=j-MJc484J85Eopm7xUBW37-hJxE2Widl86XsHnCVj80,1978
-mcsmapi/apis/file.py,sha256=LfWcVhU42xkdKfw2penZZwmgr2jPs7oKizdWuInc9a8,10610
-mcsmapi/apis/image.py,sha256=UwVH2LPfPBEADZuoSyyiMrlEc9LL858Z3oidRPaKrvs,2908
-mcsmapi/apis/instance.py,sha256=zibACXlhsMAWW5QjvGCFO5iN0wNEVlnecdnFvLeQTUg,10986
-mcsmapi/apis/overview.py,sha256=4bS3RGSykdQ1JyBTM-I9na6v0SCijEG1CN-WxqabfUo,625
-mcsmapi/apis/user.py,sha256=CBLNWxxNfvnmzoMa1YV3Q33POitYDGyN-hRORoe2JEc,2968
-mcsmapi/models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-mcsmapi/models/daemon.py,sha256=Jt4xN86U2SWTsshWPh2xVzwnEeEQ5QJ_RlIjwxyP8xk,3557
-mcsmapi/models/file.py,sha256=WpFSq6FiaracGZfhwMmWnYsCtY70c7TkpUdpW4hPmjY,2790
-mcsmapi/models/image.py,sha256=jbi4cZCYtfaG-ca7aeI5DOmXXxWTZYCYDqdkzjtuHhc,2804
-mcsmapi/models/instance.py,sha256=TeGNvZA_hBn0qbuV5xoBrnNpfwPcTjIS6b6xthvfBFc,6340
-mcsmapi/models/overview.py,sha256=TUvAqr_6h7O2ZC-CWngh8xz4zz6a4av66wgNRUN3NLg,1321
-mcsmapi/models/user.py,sha256=dw6INDrPcjT6b3PzBAgHQaVE8G6IZMKm94y6VhlSMIo,1958
-mcsmapi-0.1.5b1.dist-info/licenses/LICENSE,sha256=bMKDPsvaybvY-4TTlSZtCXPPtxb7KPpDVqXgDA8Ogo0,1068
-mcsmapi-0.1.5b1.dist-info/METADATA,sha256=hy0ptYUXph8SGp9CFR8gn9qxbcK23WWHgXfH5eWMmoY,2604
-mcsmapi-0.1.5b1.dist-info/WHEEL,sha256=DnLRTWE75wApRYVsjgc6wsVswC54sMSJhAEd4xhDpBk,91
-mcsmapi-0.1.5b1.dist-info/top_level.txt,sha256=8MUYHd1Or4cbSCd93IaqLA72w0weEuKieopVwIfVlWo,8
-mcsmapi-0.1.5b1.dist-info/RECORD,,