mcsmapi 0.1.6__py3-none-any.whl → 0.1.7__py3-none-any.whl

mcsmapi/models/daemon.py

@@ -1,93 +1,65 @@
-from typing import Any, List
+from typing import Any
 from pydantic import BaseModel
 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
+from mcsmapi.models.common import ProcessInfo, InstanceInfo, CpuMemChart
 
 
 class SystemInfo(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: list[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: SystemInfo
     """远程节点系统信息"""
-    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:
         """
@@ -98,7 +70,7 @@ class DaemonModel(BaseModel):
         """
         from mcsmapi.apis.daemon import Daemon
 
-        return Daemon().delete(self.uuid)
+        return Daemon.delete(self.uuid)
 
     def link(self) -> bool:
         """
@@ -109,7 +81,7 @@ class DaemonModel(BaseModel):
         """
         from mcsmapi.apis.daemon import Daemon
 
-        return Daemon().link(self.uuid)
+        return Daemon.link(self.uuid)
 
     def updateConfig(self, config: dict[str, Any]) -> bool:
         """
@@ -123,18 +95,18 @@ class DaemonModel(BaseModel):
         """
         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":
         """
@@ -149,7 +121,7 @@ class DaemonModel(BaseModel):
         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).dict())
 
     def deleteInstance(self, uuids: list[str], deleteFile=False) -> list[str]:
         """
@@ -164,19 +136,19 @@ class DaemonModel(BaseModel):
         """
         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,29 +1,34 @@
+from enum import IntEnum
 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:
         """
@@ -37,7 +42,7 @@ class FileItem(BaseModel):
         """
         from mcsmapi.apis.file import File
 
-        return File().rename(
+        return File.rename(
             self.daemonId, self.uuid, os.path.join(self.target, self.name), newName
         )
 
@@ -50,14 +55,14 @@ class FileItem(BaseModel):
         """
         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:
         from mcsmapi.apis.file import File
 
-        return File().copyOne(
+        return File.copyOne(
             self.daemonId, self.uuid, os.path.join(self.target, self.name), target
         )
 
@@ -73,7 +78,7 @@ class FileItem(BaseModel):
         """
         from mcsmapi.apis.file import File
 
-        return File().moveOne(
+        return File.moveOne(
             self.daemonId, self.uuid, os.path.join(self.target, self.name), target
         )
 
@@ -85,7 +90,7 @@ class FileItem(BaseModel):
         """
         from mcsmapi.apis.file import File
 
-        return File().content(
+        return File.content(
             self.daemonId, self.uuid, os.path.join(self.target, self.name)
         )
 
@@ -101,7 +106,7 @@ class FileItem(BaseModel):
         """
         from mcsmapi.apis.file import File
 
-        return File().zip(
+        return File.zip(
             self.daemonId, self.uuid, os.path.join(self.target, self.name), targets
         )
 
@@ -119,7 +124,7 @@ class FileItem(BaseModel):
         """
         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
         )
 
@@ -133,7 +138,7 @@ class FileItem(BaseModel):
         """
         from mcsmapi.apis.file import File
 
-        return File().update(
+        return File.update(
             self.daemonId, self.uuid, os.path.join(self.target, self.name), text
         )
 
@@ -145,7 +150,7 @@ class FileItem(BaseModel):
         """
         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 +158,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)
@@ -190,7 +195,7 @@ class FileList(BaseModel):
         """
         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:
         """
@@ -204,9 +209,9 @@ class FileList(BaseModel):
         """
         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:
         """
         创建文件夹
 
@@ -218,11 +223,12 @@ class FileList(BaseModel):
         """
         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 = ""

mcsmapi/models/image.py

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