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

mcsmapi/models/image.py

@@ -1,207 +1,215 @@
-from typing import List, Optional, Union
+from typing import Literal
 from pydantic import BaseModel
 
 
 class DockerConfig(BaseModel):
     """容器配置"""
 
-    """容器名称"""
     containerName: str = ""
-    """镜像名称"""
+    """容器名称"""
     image: str = ""
-    """容器分配内存(单位: 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] = []
-    """容器可使用的最大磁盘空间(单位: MB)"""
-    maxSpace: Optional[int] = None
-    """网络配置，可以是网络名称或ID"""
-    network: Optional[Union[str, int]] = None
-    """容器的 IO 限制"""
-    io: Optional[Union[str, int]] = None
-    """网络模式(例如: bridge, host)"""
+    memory: int = 0
+    """容器分配内存(单位: MB)"""
+    memorySwap: int | None = None
+    """容器分配 swap 内存(单位: MB)"""
+    memorySwappiness: int | None = None
+    """虚拟内存使用倾向(0-100)"""
     networkMode: str = "bridge"
+    """网络模式(例如: bridge, host)"""
+    networkAliases: list[str] = []
     """网络别名列表"""
-    networkAliases: List[str] = []
-    """绑定的 CPU 核心"""
-    cpusetCpus: str = ""  # 例如 `0,1`
-    """CPU 使用率(单位: %)"""
-    cpuUsage: int = 100
+    maxSpace: int = 0
+    """容器可使用的最大磁盘空间(单位: MB)"""
+    network: int = 0
+    """网络配置(已弃用)"""
+    io: int = 0
+    """容器的 IO 限制"""
+    cpusetCpus: str = ""
+    """绑定的 CPU 核心, eg: `0,1`"""
+    cpuUsage: int = 0
+    """限制CPU 使用率(单位: %)"""
+    workingDir: str = "/workspace/"
     """工作目录"""
-    workingDir: str = ""
+    env: list[str] = []
     """环境变量设置"""
-    env: List[str] = []
+    changeWorkdir: bool = True
+    """是否更变容器默认工作目录"""
 
 
 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]] = {}