mcsmapi 0.1.5b2__py3-none-any.whl → 0.1.7__py3-none-any.whl

mcsmapi/__init__.py

@@ -1,5 +1,4 @@
 import urllib.parse
-from mcsmapi.models.overview import OverviewModel
 from mcsmapi.pool import ApiPool
 from mcsmapi.apis.file import File
 from mcsmapi.apis.user import User
@@ -11,12 +10,12 @@ from mcsmapi.request import Request
 
 
 class MCSMAPI:
+
     def __init__(self, url: str, timeout: int = 5) -> None:
         split_url = urllib.parse.urlsplit(url)
         Request.set_mcsm_url(
             urllib.parse.urljoin(f"{split_url.scheme}://{split_url.netloc}", "")
         )
-        self.authentication = None
         Request.set_timeout(timeout)
 
     def login(self, username: str, password: str) -> "MCSMAPI":
@@ -35,8 +34,8 @@ class MCSMAPI:
         self.authentication = "apikey"
         return self
 
-    def overview(self) -> OverviewModel:
-        return Overview().init()
+    def overview(self) -> Overview:
+        return Overview()
 
     def instance(self) -> Instance:
         return Instance()

mcsmapi/apis/daemon.py

@@ -2,11 +2,11 @@ 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.instance import InstanceDetail
 
 
 class Daemon:
-    def show(self) -> list[DaemonConfig]:
+    @staticmethod
+    def show() -> list[DaemonConfig]:
         """
         获取全部节点配置信息
 
@@ -18,11 +18,12 @@ class Daemon:
             f"{ApiPool.SERVICE}/remote_services_list",
         )
         return [DaemonConfig(**daemon) for daemon in daemons]
-        
-    def system(self) -> list[DaemonModel]:
+
+    @staticmethod
+    def system() -> list[DaemonModel]:
         """
         获取全部节点的系统信息
-        
+
         返回:
         - List[DaemonModel]: 节点系统信息列表
         """
@@ -31,34 +32,9 @@ class Daemon:
             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:
+    @staticmethod
+    def add(config: dict[str, Any]) -> str:
         """
         新增一个节点。
 
@@ -73,8 +49,8 @@ class Daemon:
             f"{ApiPool.SERVICE}/remote_service",
             data=DaemonConfig(**config).dict(),
         )
-
-    def delete(self, daemonId: str) -> bool:
+    @staticmethod
+    def delete(daemonId: str) -> bool:
         """
         删除一个节点。
 
@@ -87,8 +63,8 @@ class Daemon:
         return send(
             "DELETE", f"{ApiPool.SERVICE}/remote_service", params={"uuid": daemonId}
         )
-
-    def link(self, daemonId: str) -> bool:
+    @staticmethod
+    def link(daemonId: str) -> bool:
         """
         连接一个节点。
 
@@ -101,11 +77,11 @@ class Daemon:
         return send(
             "GET", f"{ApiPool.SERVICE}/link_remote_service", params={"uuid": daemonId}
         )
-
-    def update(self, daemonId: str, config: dict[str, Any]) -> bool:
+    @staticmethod
+    def update(daemonId: str, config: dict[str, Any]) -> bool:
         """
         更新一个节点的配置。
-        
+
         **不建议直接使用此函数，建议调用overview()后在remote属性内使用updateConfig方法按需更新**
 
         参数:

mcsmapi/apis/file.py

@@ -1,19 +1,19 @@
 from mcsmapi.pool import ApiPool
 from mcsmapi.request import Request, send, upload
-from mcsmapi.models.file import CommonConfig, FileList
+from mcsmapi.models.file import FileDownloadConfig, FileList
 import urllib.parse
 import os
 
 
 class File:
+    @staticmethod
     def show(
-        self,
         daemonId: str,
         uuid: str,
         target: str = "",
         page: int = 0,
         page_size: int = 100,
-        file_name: str = ""
+        file_name: str = "",
     ) -> FileList:
         """
         获取文件列表
@@ -43,7 +43,8 @@ class File:
         )
         return FileList(**result, daemonId=daemonId, uuid=uuid)
 
-    def content(self, daemonId: str, uuid: str, target: str) -> str | bytes:
+    @staticmethod
+    def content(daemonId: str, uuid: str, target: str) -> str | bytes:
         """
         获取文件内容
 
@@ -62,7 +63,8 @@ class File:
             data={"target": target},
         )
 
-    def update(self, daemonId: str, uuid: str, target: str, text: str) -> bool:
+    @staticmethod
+    def update(daemonId: str, uuid: str, target: str, text: str) -> bool:
         """
         更新文件内容
 
@@ -82,7 +84,8 @@ class File:
             data={"target": target, "text": text},
         )
 
-    def download(self, daemonId: str, uuid: str, file_name: str) -> str:
+    @staticmethod
+    def download(daemonId: str, uuid: str, file_name: str) -> str:
         """
         下载文件
 
@@ -100,14 +103,13 @@ class File:
             f"{ApiPool.FILE}/download",
             params={"daemonId": daemonId, "uuid": uuid, "file_name": file_name},
         )
-        result = CommonConfig(**result)
+        result = FileDownloadConfig(**result)
         protocol = Request.mcsm_url.split("://")[0]
         base_url = urllib.parse.urljoin(f"{protocol}://{result.addr}", "download")
         return urllib.parse.urljoin(base_url, f"{result.password}/{file_name}")
 
-    async def upload(
-        self, daemonId: str, uuid: str, file: bytes, upload_dir: str
-    ) -> bool:
+    @staticmethod
+    async def upload(daemonId: str, uuid: str, file: bytes, upload_dir: str) -> bool:
         """
         上传文件
 
@@ -125,14 +127,15 @@ class File:
             f"{ApiPool.FILE}/upload",
             params={"daemonId": daemonId, "uuid": uuid, "upload_dir": upload_dir},
         )
-        result = CommonConfig(**result)
+        result = FileDownloadConfig(**result)
         protocol = Request.mcsm_url.split("://")[0]
         base_url = urllib.parse.urljoin(f"{protocol}://{result.addr}", "upload")
         final_url = urllib.parse.urljoin(base_url, result.password)
         await upload(final_url, file)
         return True
 
-    def copy(self, daemonId: str, uuid: str, copy_map: dict[str, str]) -> bool:
+    @staticmethod
+    def copy(daemonId: str, uuid: str, copy_map: dict[str, str]) -> bool:
         """
         复制多个文件夹或文件到指定位置。
 
@@ -152,7 +155,8 @@ class File:
             data={"targets": targets},
         )
 
-    def copyOne(self, daemonId: str, uuid: str, source: str, target: str) -> bool:
+    @staticmethod
+    def copyOne(daemonId: str, uuid: str, source: str, target: str) -> bool:
         """
         复制单个文件或文件夹到指定位置。
 
@@ -165,9 +169,10 @@ class File:
         **返回:**
         - bool: 移动成功后返回True。
         """
-        return self.copy(daemonId, uuid, {source: target})
+        return File.copy(daemonId, uuid, {source: target})
 
-    def move(self, daemonId: str, uuid: str, copy_map: dict[str, str]) -> bool:
+    @staticmethod
+    def move(daemonId: str, uuid: str, copy_map: dict[str, str]) -> bool:
         """
         移动多个文件或文件夹到指定位置。
 
@@ -187,7 +192,8 @@ class File:
             data={"targets": targets},
         )
 
-    def moveOne(self, daemonId: str, uuid: str, source: str, target: str) -> bool:
+    @staticmethod
+    def moveOne(daemonId: str, uuid: str, source: str, target: str) -> bool:
         """
         从源路径移动单个文件或文件夹到目标路径。
 
@@ -200,9 +206,10 @@ class File:
         返回:
         - bool: 移动成功后返回True。
         """
-        return self.move(daemonId, uuid, {source: target})
+        return File.move(daemonId, uuid, {source: target})
 
-    def rename(self, daemonId: str, uuid: str, source: str, new_name: str) -> bool:
+    @staticmethod
+    def rename(daemonId: str, uuid: str, source: str, new_name: str) -> bool:
         """
         重命名单个文件或文件夹。
 
@@ -217,9 +224,10 @@ class File:
         """
         directory = os.path.dirname(source)
         target = os.path.join(directory, new_name)
-        return self.moveOne(daemonId, uuid, source, target)
+        return File.moveOne(daemonId, uuid, source, target)
 
-    def zip(self, daemonId: str, uuid: str, source: str, targets: list[str]) -> bool:
+    @staticmethod
+    def zip(daemonId: str, uuid: str, source: str, targets: list[str]) -> bool:
         """
         压缩多个文件或文件夹到指定位置。
 
@@ -239,8 +247,9 @@ class File:
             data={"type": 1, "code": "utf-8", "source": source, "targets": targets},
         )
 
+    @staticmethod
     def unzip(
-        self, daemonId: str, uuid: str, source: str, target: str, code: str = "utf-8"
+        daemonId: str, uuid: str, source: str, target: str, code: str = "utf-8"
     ) -> bool:
         """
         解压缩指定的zip文件到目标位置。
@@ -263,7 +272,8 @@ class File:
             data={"type": 2, "code": code, "source": source, "targets": target},
         )
 
-    def delete(self, daemonId: str, uuid: str, targets: list[str]) -> bool:
+    @staticmethod
+    def delete(daemonId: str, uuid: str, targets: list[str]) -> bool:
         """
         删除多个文件或文件夹。
 
@@ -282,7 +292,8 @@ class File:
             data={"targets": targets},
         )
 
-    def createFile(self, daemonId: str, uuid: str, target: str) -> bool:
+    @staticmethod
+    def createFile(daemonId: str, uuid: str, target: str) -> bool:
         """
         创建文件。
 
@@ -301,7 +312,8 @@ class File:
             data={"target": target},
         )
 
-    def createFloder(self, daemonId: str, uuid: str, target: str) -> bool:
+    @staticmethod
+    def createFolder(daemonId: str, uuid: str, target: str) -> bool:
         """
         创建文件夹
 

mcsmapi/apis/image.py

@@ -4,7 +4,8 @@ from mcsmapi.models.image import DockerImageItem, DockerContainerItem, DockerNet
 
 
 class Image:
-    def images(self, daemonId: str) -> list[DockerImageItem]:
+    @staticmethod
+    def images(daemonId: str) -> list[DockerImageItem]:
         """
         获取镜像列表
 
@@ -24,7 +25,8 @@ class Image:
 
         return [DockerImageItem(**item) for item in result]
 
-    def containers(self, daemonId: str) -> list[DockerContainerItem]:
+    @staticmethod
+    def containers(daemonId: str) -> list[DockerContainerItem]:
         """
         获取容器列表
 
@@ -44,7 +46,8 @@ class Image:
 
         return [DockerContainerItem(**item) for item in result]
 
-    def network(self, daemonId: str) -> list[DockerNetworkItem]:
+    @staticmethod
+    def network(daemonId: str) -> list[DockerNetworkItem]:
         """
         获取网络接口列表
 
@@ -63,7 +66,8 @@ class Image:
         )
         return [DockerNetworkItem(**item) for item in result]
 
-    def add(self, daemonId: str, dockerFile: str, name: str, tag: str) -> bool:
+    @staticmethod
+    def add(daemonId: str, dockerFile: str, name: str, tag: str) -> bool:
         """
         新增一个镜像
 
@@ -83,7 +87,8 @@ class Image:
             data={"dockerFile": dockerFile, "name": name, "tag": tag},
         )
 
-    def progress(self, daemonId: str) -> dict[str, int]:
+    @staticmethod
+    def progress(daemonId: str) -> dict[str, int]:
         """
         获取镜像构建进度
 

mcsmapi/apis/instance.py

@@ -10,8 +10,8 @@ from mcsmapi.models.instance import (
 
 
 class Instance:
+    @staticmethod
     def search(
-        self,
         daemonId: str,
         page: int = 1,
         page_size: int = 20,
@@ -49,7 +49,8 @@ class Instance:
         )
         return InstanceSearchList(**result, daemonId=daemonId)
 
-    def detail(self, daemonId: str, uuid: str) -> InstanceDetail:
+    @staticmethod
+    def detail(daemonId: str, uuid: str) -> InstanceDetail:
         """
         获取指定实例的详细信息
 
@@ -67,7 +68,8 @@ class Instance:
         )
         return InstanceDetail(**result)
 
-    def create(self, daemonId: str, config: dict[str, Any]) -> InstanceCreateResult:
+    @staticmethod
+    def create(daemonId: str, config: dict[str, Any]) -> InstanceCreateResult:
         """
         创建一个实例。
 
@@ -86,10 +88,11 @@ class Instance:
         )
         return InstanceCreateResult(**result)
 
-    def updateConfig(self, daemonId: str, uuid: str, config: dict) -> str | bool:
+    @staticmethod
+    def updateConfig(daemonId: str, uuid: str, config: dict) -> str | bool:
         """
         更新实例配置。
-        
+
         **不建议直接使用此函数，建议调用search后在data属性内使用updateConfig方法按需更新**
 
         **参数:**
@@ -108,9 +111,8 @@ class Instance:
         )
         return result.get("uuid", True)
 
-    def delete(
-        self, daemonId: str, uuids: list[str], deleteFile: bool = False
-    ) -> list[str]:
+    @staticmethod
+    def delete(daemonId: str, uuids: list[str], deleteFile: bool = False) -> list[str]:
         """
         删除实例。
 
@@ -129,7 +131,8 @@ class Instance:
             data={"uuids": uuids, "deleteFile": deleteFile},
         )
 
-    def start(self, daemonId: str, uuid: str) -> str | bool:
+    @staticmethod
+    def start(daemonId: str, uuid: str) -> str | bool:
         """
         启动实例。
 
@@ -147,7 +150,8 @@ class Instance:
         )
         return result.get("instanceUuid", True)
 
-    def stop(self, daemonId: str, uuid: str) -> str | bool:
+    @staticmethod
+    def stop(daemonId: str, uuid: str) -> str | bool:
         """
         关闭实例。
 
@@ -165,7 +169,8 @@ class Instance:
         )
         return result.get("instanceUuid", True)
 
-    def restart(self, daemonId: str, uuid: str) -> str | bool:
+    @staticmethod
+    def restart(daemonId: str, uuid: str) -> str | bool:
         """
         重启实例。
 
@@ -183,7 +188,8 @@ class Instance:
         )
         return result.get("instanceUuid", True)
 
-    def kill(self, daemonId: str, uuid: str) -> str | bool:
+    @staticmethod
+    def kill(daemonId: str, uuid: str) -> str | bool:
         """
         强制关闭实例。
 
@@ -201,7 +207,8 @@ class Instance:
         )
         return result.get("instanceUuid", True)
 
-    def batchOperation(self, instances: list[dict[str, str]], operation: str) -> bool:
+    @staticmethod
+    def batchOperation(instances: list[dict[str, str]], operation: str) -> bool:
         """
         对多个实例进行批量操作。
 
@@ -217,7 +224,8 @@ class Instance:
         else:
             raise ValueError("operation must be one of start, stop, restart, kill")
 
-    def update(self, daemonId: str, uuid: str) -> bool:
+    @staticmethod
+    def update(daemonId: str, uuid: str) -> bool:
         """
         升级实例。
 
@@ -229,12 +237,13 @@ class Instance:
         - bool: 返回操作结果，成功时返回True。
         """
         return send(
-            "GET",
+            "POST",
             f"{ApiPool.PROTECTED_INSTANCE}/asynchronous",
             params={"daemonId": daemonId, "uuid": uuid, "task_name": "update"},
         )
 
-    def command(self, daemonId: str, uuid: str, command: str) -> str:
+    @staticmethod
+    def command(daemonId: str, uuid: str, command: str) -> str:
         """
         向实例发送命令。
 
@@ -253,7 +262,8 @@ class Instance:
         )
         return result.get("instanceUuid", True)
 
-    def get_output(self, daemonId: str, uuid: str, size: int | str = "") -> str:
+    @staticmethod
+    def get_output(daemonId: str, uuid: str, size: int | str = "") -> str:
         """
         获取实例输出。
 
@@ -271,8 +281,8 @@ class Instance:
             params={"daemonId": daemonId, "uuid": uuid, "size": size},
         )
 
+    @staticmethod
     def reinstall(
-        self,
         daemonId: str,
         uuid: str,
         targetUrl: str,

mcsmapi/apis/overview.py

@@ -1,17 +1,21 @@
 from mcsmapi.pool import ApiPool
 from mcsmapi.request import send
-from mcsmapi.models.overview import OverviewModel
+from mcsmapi.models.overview import OverviewModel, LogDetail
 
 
 class Overview:
-    def init(self):
+    @staticmethod
+    def overview():
         """
-        初始化方法，用于获取API概览信息并构建概览模型。
-
-        本方法通过发送GET请求获取API概览信息，确保返回的数据类型为字典，
-        然后使用这些数据来构建一个OverviewModel实例。
-
-        :return: 返回一个OverviewModel实例，该实例使用获取的API概览信息进行初始化。
+        获取面板基本信息
         """
         result = send("GET", ApiPool.OVERVIEW)
         return OverviewModel(**result)
+    
+    @staticmethod
+    def logs():
+        """
+        获取面板操作日志
+        """
+        result = send("GET", ApiPool.LOG)
+        return [LogDetail(**item) for item in result]

mcsmapi/apis/user.py

@@ -5,8 +5,9 @@ from mcsmapi.models.user import SearchUserModel, UserConfig
 
 
 class User:
+    @staticmethod
     def search(
-        self, username: str = "", page: int = 1, page_size: int = 20, role: str = ""
+        username: str = "", page: int = 1, page_size: int = 20, role: str = ""
     ) -> SearchUserModel:
         """根据用户名和角色搜索用户信息
 
@@ -32,7 +33,8 @@ class User:
         )
         return SearchUserModel(**result)
 
-    def create(self, username: str, password: str, permission: int = 1) -> str | bool:
+    @staticmethod
+    def create(username: str, password: str, permission: int = 1) -> str | bool:
         """
         创建新用户的方法
 
@@ -50,7 +52,8 @@ class User:
             data={"username": username, "password": password, "permission": permission},
         ).get("uuid", True)
 
-    def update(self, uuid: str, config: dict[str, Any]) -> bool:
+    @staticmethod
+    def update(uuid: str, config: dict[str, Any]) -> bool:
         """
         更新用户信息的方法
 
@@ -66,10 +69,11 @@ class User:
         return send(
             "PUT",
             ApiPool.AUTH,
-            data={"uuid": uuid, "config": UserConfig(**config).dict()},
+            data={"uuid": uuid, "config": UserConfig(**config).model_dump()},
         )
 
-    def delete(self, uuids: list[str]) -> bool:
+    @staticmethod
+    def delete(uuids: list[str]) -> bool:
         """
         删除用户的方法
 

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资源(单位: byte)"""
+    memory: int
+    """远程节点使用的内存资源(单位: byte)"""
+    cwd: str
+    """远程节点的工作路径"""
+
+
+class InstanceInfo(BaseModel):
+    """实例统计信息"""
+
+    running: int
+    """运行中实例数量"""
+    total: int
+    """全部实例数量"""