refactor(core): 主操作类获取方式改为属性，新增计划任务管理 (#18)

* refactor(core): 主操作类获取方式改为属性，新增计划任务管理

- 为MCSMAPI类添加@Property装饰器，使overview、instance、user、daemon、file、image等方法可以作为属性访问，
简化了调用方式。同时删除了多余的括号调用，在examples中更新了所有相关调用方式。

- resolve [Feature Request]: 计划任务管理
Fixes #17

BREAKING CHANGE: 原来的mcsm.daemon()、mcsm.instance()等调用方式需要改为mcsm.daemon、mcsm.instance

* feat(schedule): 更新计划任务API接口参数

为计划任务的创建和更新方法添加daemonId和uuid参数，
使接口调用更加明确和一致。

fix(daemon): 改进节点系统信息模型定义

将DaemonSystemInfo模型中的字段改为可选类型，改进文档字符串描述，
使节点信息处理更加灵活。

refactor(instance): 优化实例信息获取逻辑

重构get_all_instance_info函数，使用字典推导式简化代码，
移除不必要的断言和文件写入操作。

feat(instance): 添加实例计划任务创建功能

在InstanceDetail类中添加create_schedule方法，
方便通过实例对象直接创建计划任务。

refactor(overview): 优化节点可用性检查逻辑

使用海象运算符简化节点可用性检查，添加类型忽略注释，
提高代码可读性。

* refactor(core): 移除不必要的海象操作符并优化代码结构

移除example/overview.py中的海象操作符(Available assignment operator)，
使代码更加清晰易读。

优化mcsmapi/apis/schedule.py中的Schedule.create方法调用，
直接使用类方法替代复杂的send函数调用，提高代码可维护性。

Author: molanp

example/daemon.py

@@ -1,26 +1,26 @@
 from mcsmapi import MCSMAPI
+from mcsmapi.models.daemon import DaemonConfig
 
 mcsm = MCSMAPI("http://localhost:23333")
 
 mcsm.login("admin", "547cABC9bf88@")
 
 # mcsm.login_with_apikey("apikey")
 
-daemon_object = mcsm.daemon()
+daemon_object = mcsm.daemon
 
 # show Daemon list
 
 print(daemon_object.config())
 
 # 创建节点
 daemonId = daemon_object.add(
-    {
-        "ip": "localhost",
-        "port": 24444,
-        "prefix": "",
-        "remarks": "Unnamed Node",
-        "available": True,
-    }
+    DaemonConfig(
+        ip="localhost",
+        port=24444,
+        prefix="",
+        remarks="Unnamed Node",
+    )
 )
 # 删除节点
 daemon_object.delete(daemonId)

example/instance.py

@@ -4,7 +4,7 @@
 
 api.login("admin", "547cABC9bf88@")
 
-instance_object = api.instance()
+instance_object = api.instance
 
 instance_list = instance_object.search("xxx")
 
@@ -37,7 +37,7 @@
 f.rename("new_name")
 
 # copy file
-f.copy("new_path")
+f.copy_to("new_path")
 # move file
 f.move("new_path")
 

example/overview.py

@@ -7,7 +7,7 @@
 # mcsm.login_with_apikey("apikey")
 
 # Get dashboard data
-overview = mcsm.overview()
+overview = mcsm.overview
 overview_data = overview.overview()
 
 mcsm_version = overview_data.version
@@ -19,12 +19,14 @@
     print(remote.ip)
     print(remote.port)
     print(remote.prefix)
-    print(remote.available)
-    print(remote.version)
-    print(remote.process.cpu)
-    print(remote.system.freemem)
-    print(remote.system.hostname)
-    print(remote.system.loadavg)
+    if remote.available:
+        print(remote.version)
+        print(remote.process.cpu) # type: ignore
+        print(remote.system.freemem) # type: ignore
+        print(remote.system.hostname) # type: ignore
+        print(remote.system.loadavg) # type: ignore
+    else:
+        print("Not available")
 
 
 remote = remotes[0]

example/use_case/get_all_instance_info.py

@@ -17,19 +17,18 @@
 # Get all instance info
 def get_all_instance_info(daemon_id: str):
     # Get all instance info from the daemon
-    instance_object = mcsm.instance()
+    instance_object = mcsm.instance
     instance_list = instance_object.search(daemonId=daemon_id).data
-    
-    # Create a dictionary to store instance info
-    instance_dict = {}
-    for instance in instance_list:
-        instance_dict[instance.instanceUuid] = {
+
+    return {
+        instance.instanceUuid: {
             "name": instance.config.nickname,
             "status": instance.status,
             "daemonId": instance.daemonId,
             "uuid": instance.instanceUuid,
         }
-    return instance_dict
+        for instance in instance_list
+    }
 
 # Example usage
 daemon_id = "your_daemon_id" # Please change to your MCSM panel daemon id.
@@ -41,4 +40,3 @@ def get_all_instance_info(daemon_id: str):
 # Optional: Save info to a file in the current directory
 with open("instance_info.json", "w") as f:
     content = json.dump(instance_info, f, indent=4)
-    f.write(content)

example/use_case/search_instance_by_name.py

@@ -1,5 +1,4 @@
 from mcsmapi import MCSMAPI
-import json
 
 baseurl = "http://localhost:23333" # Change to your MCSM panel address and port(include http or https etc.).
 
@@ -17,7 +16,7 @@
 # Get instance 
 def get_instance(daemon_id: str, instance_name: str):
     # Get specific instance info from the daemon by name
-    instance_object = mcsm.instance()
+    instance_object = mcsm.instance
     instance_list = instance_object.search(daemonId=daemon_id, instance_name=instance_name).data
 
     # Error handling
@@ -41,17 +40,16 @@ def get_instance(daemon_id: str, instance_name: str):
 # Print instance status
 print(instance.config.nickname)
 print(instance.status)
-print(instance.space)
 
 # Optional:
 # start
-#instance.start()
+instance.start()
 
 # stop
-#instance.stop()
+instance.stop()
 
 # restart
-#instance.restart()
+instance.restart()
 
 # kill
-#instance.kill()
+instance.kill()

example/user.py

@@ -4,7 +4,7 @@
 
 api.login("admin", "547cABC9bf88@")
 
-userManager = api.user()
+userManager = api.user
 
 users = userManager.search()
 
@@ -13,7 +13,7 @@
     print(user.userName)
 
 # 查找第一个管理员账号
-user = api.user().search(role=10).data[0]
+user = userManager.search(role=10).data[0]
 
 # 封禁管理员账号
 user.update({"permission": -1})

mcsmapi/__init__.py

@@ -34,20 +34,26 @@ def login_with_apikey(self, apikey: str):
         self.authentication = "apikey"
         return self
 
+    @property
     def overview(self):
         return Overview()
 
+    @property
     def instance(self):
         return Instance()
 
+    @property
     def user(self) :
         return User()
 
+    @property
     def daemon(self):
         return Daemon()
 
+    @property
     def file(self):
         return File()
 
+    @property
     def image(self):
         return Image()

mcsmapi/apis/daemon.py

@@ -51,18 +51,18 @@ def system() -> list[DaemonSystemInfo]:
         return [DaemonSystemInfo(**daemon) for daemon in daemons]
 
     @staticmethod
-    def add(config: dict[str, Any]) -> str:
+    def add(config: DaemonConfig) -> str:
         """
         新增一个节点
 
-        :params config: 节点的配置信息，以字典形式提供，缺失内容由DaemonConfig模型补全
+        :params config: 节点的配置信息
 
         :returns: 新增节点的UUID
         """
         return send(
             "POST",
             f"{ApiPool.SERVICE}/remote_service",
-            data=DaemonConfig(**config).model_dump(),
+            data=config.model_dump(),
         )
 
     @staticmethod

mcsmapi/apis/file.py

@@ -126,7 +126,7 @@ async def upload(daemonId: str, uuid: str, file: bytes, upload_dir: str) -> bool
         return True
 
     @staticmethod
-    def copy(daemonId: str, uuid: str, copy_map: dict[str, str]) -> bool:
+    def copy_to(daemonId: str, uuid: str, copy_map: dict[str, str]) -> bool:
         """
         复制多个文件夹或文件到指定位置
 
@@ -156,7 +156,7 @@ def copyOne(daemonId: str, uuid: str, source: str, target: str) -> bool:
 
         :returns: 操作成功后返回True
         """
-        return File.copy(daemonId, uuid, {source: target})
+        return File.copy_to(daemonId, uuid, {source: target})
 
     @staticmethod
     def move(daemonId: str, uuid: str, copy_map: dict[str, str]) -> bool:

mcsmapi/apis/schedule.py

@@ -0,0 +1,71 @@
+from mcsmapi.pool import ApiPool
+from mcsmapi.request import send
+from mcsmapi.models.schedule import ScheduleDetail, SchedulePostBody
+
+
+class Schedule:
+
+    @staticmethod
+    def list(daemonId: str, uuid: str) -> list[ScheduleDetail]:
+        """
+        获取实例计划任务列表
+
+        :param daemonId: 节点ID
+        :param uuid: 实例ID
+
+        :returns: 计划任务列表
+        """
+        result = send(
+            "GET",
+            f"{ApiPool.SCHEDULE}",
+            params={"daemonId": daemonId, "uuid": uuid},
+        )
+        return [ScheduleDetail(**r, daemonId=daemonId) for r in result]
+
+    @staticmethod
+    def delete(daemonId: str, uuid: str, task_name: str) -> bool:
+        """
+        删除计划任务
+
+        :param daemonId: 节点ID
+        :param uuid: 实例ID
+        :param task_name: 计划任务名称
+
+        :returns: 是否成功
+        """
+        return send(
+            "DELETE",
+            f"{ApiPool.SCHEDULE}",
+            params={"daemonId": daemonId, "uuid": uuid, "task_name": task_name},
+        )
+
+    @staticmethod
+    def create(daemonId: str, uuid: str, config: SchedulePostBody) -> bool:
+        """
+        创建计划任务
+
+        :param daemonId: 节点ID
+        :param uuid: 实例ID
+        :param config: 计划任务配置
+
+        :returns: 是否成功
+        """
+        return send(
+            "POST",
+            f"{ApiPool.SCHEDULE}",
+            params={"daemonId": daemonId, "uuid": uuid},
+            data=config.model_dump(),
+        )
+
+    @staticmethod
+    def update(daemonId: str, uuid: str, config: SchedulePostBody) -> bool:
+        """
+        更新计划任务
+
+        :param daemonId: 节点ID
+        :param uuid: 实例ID
+        :param config: 计划任务配置
+
+        :returns: 是否成功
+        """
+        return Schedule.create(daemonId, uuid, config)