mcsmapi 0.1.6__tar.gz → 0.1.8b1__tar.gz

{mcsmapi-0.1.6 → mcsmapi-0.1.8b1}/PKG-INFO

@@ -1,15 +1,17 @@
 Metadata-Version: 2.4
 Name: mcsmapi
-Version: 0.1.6
+Version: 0.1.8b1
 Summary: Shortcut the pypi package of MCSM./快捷操作MCSM的pypi包
 Author-email: molanp <molanpp@outlook.com>
 License-Expression: MIT
 Project-URL: Source, https://github.com/molanp/mcsmapi
 Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: requests
-Requires-Dist: pydantic
+Requires-Dist: pydantic<3.0.0,>=2.0.0
 Dynamic: license-file
 
 # MCSM API
@@ -82,9 +84,10 @@ mcsm.login_with_apikey("apikey")
 
 # Get dashboard data
 overview = mcsm.overview()
+overview_data = overview.overview()
 
 # Get MCSM version
-mcsm_version = mcsm.overview().version
+mcsm_version = overview_data.version
 ```
 
 ## Contributing

{mcsmapi-0.1.6 → mcsmapi-0.1.8b1}/README.md

@@ -68,9 +68,10 @@ mcsm.login_with_apikey("apikey")
 
 # Get dashboard data
 overview = mcsm.overview()
+overview_data = overview.overview()
 
 # Get MCSM version
-mcsm_version = mcsm.overview().version
+mcsm_version = overview_data.version
 ```
 
 ## Contributing

{mcsmapi-0.1.6 → mcsmapi-0.1.8b1}/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-0.1.8b1/mcsmapi/apis/daemon.py

@@ -0,0 +1,92 @@
+from typing import Any
+from mcsmapi.pool import ApiPool
+from mcsmapi.request import send
+from mcsmapi.models.daemon import DaemonConfig, DaemonModel
+
+
+class Daemon:
+    @staticmethod
+    def show() -> list[DaemonConfig]:
+        """
+        获取全部节点配置信息
+
+        :returns: 节点的配置信息列表
+        """
+        daemons = send(
+            "GET",
+            f"{ApiPool.SERVICE}/remote_services_list",
+        )
+        return [DaemonConfig(**daemon) for daemon in daemons]
+
+    @staticmethod
+    def system() -> list[DaemonModel]:
+        """
+        获取全部节点的系统信息
+
+        :returns: 节点系统信息列表
+        """
+        daemons = send(
+            "GET",
+            f"{ApiPool.SERVICE}/remote_services_system",
+        )
+        return [DaemonModel(**daemon) for daemon in daemons]
+
+    @staticmethod
+    def add(config: dict[str, Any]) -> str:
+        """
+        新增一个节点
+
+        :params config: 节点的配置信息，以字典形式提供，缺失内容由DaemonConfig模型补全
+
+        :returns: 新增节点的UUID
+        """
+        return send(
+            "POST",
+            f"{ApiPool.SERVICE}/remote_service",
+            data=DaemonConfig(**config).model_dump(),
+        )
+
+    @staticmethod
+    def delete(daemonId: str) -> bool:
+        """
+        删除一个节点
+
+        :params daemonId: 节点的UUID
+
+        :returns: 删除成功后返回True
+        """
+        return send(
+            "DELETE", f"{ApiPool.SERVICE}/remote_service", params={"uuid": daemonId}
+        )
+
+    @staticmethod
+    def link(daemonId: str) -> bool:
+        """
+        连接一个节点
+
+        :params daemonId: 节点的UUID
+
+        :returns: 连接成功后返回True
+        """
+        return send(
+            "GET", f"{ApiPool.SERVICE}/link_remote_service", params={"uuid": daemonId}
+        )
+
+    @staticmethod
+    def update(daemonId: str, config: dict[str, Any]) -> bool:
+        """
+        更新一个节点的配置
+
+        **不建议直接使用此函数，建议调用overview()后在remote属性内使用节点对象的updateConfig方法按需更新**
+
+        :params daemonId: 节点的UUID
+        :params config: 节点的配置信息，以字典形式提供，缺失内容由DaemonConfig模型补全
+
+        :returns: 更新成功后返回True
+        """
+        return send(
+            "PUT",
+            f"{ApiPool.SERVICE}/remote_service",
+            params={"uuid": daemonId},
+            data=DaemonConfig(**config).model_dump(),
+        )

mcsmapi-0.1.8b1/mcsmapi/apis/file.py

@@ -0,0 +1,308 @@
+from typing import Literal
+from mcsmapi.pool import ApiPool
+from mcsmapi.request import Request, send, upload
+from mcsmapi.models.file import FileDownloadConfig, FileList
+import urllib.parse
+import os
+
+
+class File:
+    @staticmethod
+    def show(
+        daemonId: str,
+        uuid: str,
+        target: str = "",
+        page: int = 0,
+        page_size: int = 100,
+        file_name: str = "",
+    ) -> FileList:
+        """
+        获取文件列表
+
+        :params daemonId: 节点的UUID
+        :params uuid: 实例的UUID
+        :params target: 用于文件过滤的目标路径
+        :params page: 指定分页的页码
+        :params page_size: 指定每页的文件数量
+        :params file_name: 用于在文件列表中过滤出名称包含指定字符串的文件或文件夹
+
+        :returns: 包含文件列表信息和分页详情的FileList模型
+        """
+        result = send(
+            "GET",
+            f"{ApiPool.FILE}/list",
+            params={
+                "daemonId": daemonId,
+                "uuid": uuid,
+                "target": target,
+                "page": page,
+                "page_size": page_size,
+                "file_name": file_name,
+            },
+        )
+        return FileList(**result, daemonId=daemonId, uuid=uuid)
+
+    @staticmethod
+    def content(daemonId: str, uuid: str, target: str) -> str:
+        """
+        获取文件内容
+
+        :params daemonId: 节点的UUID
+        :params uuid: 实例的UUID
+        :params target: 文件的目标路径
+
+        :returns: 文件的内容信息
+        """
+        return send(
+            "PUT",
+            f"{ApiPool.FILE}",
+            params={"daemonId": daemonId, "uuid": uuid},
+            data={"target": target},
+        )
+
+    @staticmethod
+    def update(daemonId: str, uuid: str, target: str, text: str) -> bool:
+        """
+        更新文件内容
+
+        :params daemonId: 节点的UUID
+        :params uuid: 实例的UUID
+        :params target: 目标文件的路径
+        :params text: 新的文件内容
+
+        :returns: 更新成功后返回True
+        """
+        return send(
+            "PUT",
+            f"{ApiPool.FILE}",
+            params={"daemonId": daemonId, "uuid": uuid},
+            data={"target": target, "text": text},
+        )
+
+    @staticmethod
+    def download(daemonId: str, uuid: str, file_name: str) -> str:
+        """
+        下载文件
+
+        :params daemonId: 节点的UUID
+        :params uuid: 实例的UUID
+        :params file_name: 要下载的文件的实例内完整路径, eg: /backup/world.zip
+
+        :returns: 文件下载URL
+        """
+
+        result = send(
+            "POST",
+            f"{ApiPool.FILE}/download",
+            params={"daemonId": daemonId, "uuid": uuid, "file_name": file_name},
+        )
+        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}")
+
+    @staticmethod
+    async def upload(daemonId: str, uuid: str, file: bytes, upload_dir: str) -> bool:
+        """
+        上传文件
+
+        :params daemonId: 节点的UUID
+        :params uuid: 实例的UUID
+        :params file: 要上传的文件内容
+        :params upload_dir: 文件上传到的目标路径
+
+        :returns: 上传成功后返回True
+        """
+        result = send(
+            "POST",
+            f"{ApiPool.FILE}/upload",
+            params={"daemonId": daemonId, "uuid": uuid, "upload_dir": upload_dir},
+        )
+        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
+
+    @staticmethod
+    def copy(daemonId: str, uuid: str, copy_map: dict[str, str]) -> bool:
+        """
+        复制多个文件夹或文件到指定位置
+
+        :params daemonId: 节点的UUID
+        :params uuid: 实例的UUID
+        :params copy_map: 复制映射，格式为 {源路径: 目标路径}
+
+        :returns: 复制成功后返回True
+        """
+        targets = [[source, target] for source, target in copy_map.items()]
+        return send(
+            "POST",
+            f"{ApiPool.FILE}/copy",
+            params={"daemonId": daemonId, "uuid": uuid},
+            data={"targets": targets},
+        )
+
+    @staticmethod
+    def copyOne(daemonId: str, uuid: str, source: str, target: str) -> bool:
+        """
+        复制单个文件或文件夹到指定位置
+
+        :params daemonId: 节点的UUID
+        :params uuid: 实例的UUID
+        :params source: 源文件或文件夹的路径
+        :params target: 目标文件或文件夹的路径
+
+        :return: 移动成功后返回True
+        """
+        return File.copy(daemonId, uuid, {source: target})
+
+    @staticmethod
+    def move(daemonId: str, uuid: str, copy_map: dict[str, str]) -> bool:
+        """
+        移动多个文件或文件夹到指定位置
+
+        :params daemonId: 节点的UUID
+        :params uuid: 实例的UUID
+        :params copy_map: 移动映射，格式为 {源路径: 目标路径}
+
+        :returns: 移动成功后返回True
+        """
+        targets = [[source, target] for source, target in copy_map.items()]
+        return send(
+            "PUT",
+            f"{ApiPool.FILE}/move",
+            params={"daemonId": daemonId, "uuid": uuid},
+            data={"targets": targets},
+        )
+
+    @staticmethod
+    def moveOne(daemonId: str, uuid: str, source: str, target: str) -> bool:
+        """
+        从源路径移动单个文件或文件夹到目标路径
+
+        :params daemonId: 节点的UUID
+        :params uuid: 实例的UUID
+        :params source: 源文件或文件夹的路径
+        :params target: 目标文件或文件夹的路径
+
+        :returns: 移动成功后返回True
+        """
+        return File.move(daemonId, uuid, {source: target})
+
+    @staticmethod
+    def rename(daemonId: str, uuid: str, source: str, new_name: str) -> bool:
+        """
+        重命名单个文件或文件夹
+
+        :params daemonId: 节点的UUID
+        :params uuid: 实例的UUID
+        :params source: 源文件或文件夹的路径
+        :params new_name: 源文件或文件夹的新名字
+
+        :returns: 重命名成功后返回True
+        """
+        directory = os.path.dirname(source)
+        target = os.path.join(directory, new_name)
+        return File.moveOne(daemonId, uuid, source, target)
+
+    @staticmethod
+    def zip(daemonId: str, uuid: str, source: str, targets: list[str]) -> bool:
+        """
+        压缩多个文件或文件夹到指定位置
+
+        :params daemonId: 节点的UUID
+        :params uuid: 实例的UUID
+        :params source: 要压缩到的目标文件的路径
+        :params targets: 需要压缩的文件路径
+
+        **返回:**
+        - bool: 压缩成功后返回True
+        """
+        return send(
+            "POST",
+            f"{ApiPool.FILE}/compress",
+            params={"daemonId": daemonId, "uuid": uuid},
+            data={"type": 1, "code": "utf-8", "source": source, "targets": targets},
+        )
+
+    @staticmethod
+    def unzip(
+        daemonId: str,
+        uuid: str,
+        source: str,
+        targets: str,
+        code: Literal["utf-8", "gbk", "big5"] = "utf-8",
+    ) -> bool:
+        """
+        解压缩指定的zip文件到目标位置
+
+        :params daemonId: 节点的UUID
+        :params uuid: 实例的UUID
+        :params source: 需要解压的zip文件路径
+        :params targets: 解压到的目标路径
+        :params code: 压缩文件的编码方式
+
+        :returns: 解压成功后返回True
+        """
+        return send(
+            "POST",
+            f"{ApiPool.FILE}/compress",
+            params={"daemonId": daemonId, "uuid": uuid},
+            data={"type": 2, "code": code, "source": source, "targets": targets},
+        )
+
+    @staticmethod
+    def delete(daemonId: str, uuid: str, targets: list[str]) -> bool:
+        """
+        删除多个文件或文件夹
+
+        :params daemonId: 节点的UUID
+        :params uuid: 实例的UUID
+        :params targets: 要删除的文件或文件夹的路径
+
+        :returns: 删除成功后返回True
+        """
+        return send(
+            "DELETE",
+            ApiPool.FILE,
+            params={"daemonId": daemonId, "uuid": uuid},
+            data={"targets": targets},
+        )
+
+    @staticmethod
+    def createFile(daemonId: str, uuid: str, target: str) -> bool:
+        """
+        创建文件
+
+        :params daemonId: 节点的UUID
+        :params uuid: 实例的UUID
+        :params target: 目标文件的路径，包含文件名
+
+        :returns: 创建成功后返回True
+        """
+        return send(
+            "POST",
+            f"{ApiPool.FILE}/touch",
+            params={"daemonId": daemonId, "uuid": uuid},
+            data={"target": target},
+        )
+
+    @staticmethod
+    def createFolder(daemonId: str, uuid: str, target: str) -> bool:
+        """
+        创建文件夹
+
+        :params daemonId: 节点的UUID
+        :params uuid: 实例的UUID
+        :params target: 目标文件夹的路径
+
+        :returns: 创建成功后返回True
+        """
+        return send(
+            "POST",
+            f"{ApiPool.FILE}/mkdir",
+            params={"daemonId": daemonId, "uuid": uuid},
+            data={"target": target},
+        )

{mcsmapi-0.1.6 → mcsmapi-0.1.8b1}/mcsmapi/apis/image.py

@@ -4,15 +4,14 @@ from mcsmapi.models.image import DockerImageItem, DockerContainerItem, DockerNet
 
 
 class Image:
-    def images(self, daemonId: str) -> list[DockerImageItem]:
+    @staticmethod
+    def images(daemonId: str) -> list[DockerImageItem]:
         """
         获取镜像列表
 
-        **参数:**
-        - daemonId (str): 守护进程的唯一标识符。
+        :params daemonId: 节点的UUID
 
-        **返回:**
-        - list[ImageModel]: 包含镜像列表详情的 ImageModel 模型的列表。
+        :returns: 包含镜像列表详情的 ImageModel 模型的列表
         """
         result = send(
             "GET",
@@ -24,15 +23,14 @@ class Image:
 
         return [DockerImageItem(**item) for item in result]
 
-    def containers(self, daemonId: str) -> list[DockerContainerItem]:
+    @staticmethod
+    def containers(daemonId: str) -> list[DockerContainerItem]:
         """
         获取容器列表
 
-        **参数:**
-        - daemonId (str): 守护进程的唯一标识符。
+        :params daemonId: 节点的UUID
 
-        **返回:**
-        - list[DockerContainerItem]: 包含容器列表详情的 DockerContainerItem 模型的列表。
+        :params: 包含容器列表详情的 DockerContainerItem 模型的列表
         """
         result = send(
             "GET",
@@ -44,15 +42,14 @@ class Image:
 
         return [DockerContainerItem(**item) for item in result]
 
-    def network(self, daemonId: str) -> list[DockerNetworkItem]:
+    @staticmethod
+    def network(daemonId: str) -> list[DockerNetworkItem]:
         """
         获取网络接口列表
 
-        **参数:**
-        - daemonId (str): 守护进程的唯一标识符。
+        :params daemonId: 节点的UUID
 
-        **返回:**
-        - list[DockerNetworkItem]: 包含网络接口列表详情的 DockerNetworkItem 模型的列表。
+        :returns: 包含网络接口列表详情的 DockerNetworkItem 模型的列表
         """
         result = send(
             "GET",
@@ -63,18 +60,17 @@ 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:
         """
         新增一个镜像
 
-        **参数:**
-        - daemonId (str): 守护进程的唯一标识符。
-        - dockerFile (str): DockerFile Config
-        - name (str): 镜像名称。
-        - tag (str): 镜像版本。
+        :params daemonId: 节点的UUID
+        :params dockerFile: DockerFile Config 内容
+        :params name: 镜像名称
+        :params tag: 镜像版本
 
-        **返回:**
-        - bool: 新增镜像成功后返回True。
+        :returns: 新增镜像成功后返回True
         """
         return send(
             "POST",
@@ -83,17 +79,20 @@ 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]:
         """
         获取镜像构建进度
 
-        ## **由于文档此部分内容不详，未使用模型**
+        :params daemonId: 节点的UUID
 
-        **参数:**
-        - daemonId (str): 守护进程的唯一标识符。
+        :returns: {容器名称: 当前状态}
 
-        **返回:**
-        - dict[str, int]: 包含构建进度信息的字典。
+        状态码对照:
+        ```
+        -1: 镜像构建失败
+         1: 镜像构建中
+         2: 镜像构建完成
         """
         return send(
             "GET",