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

mcsmapi/models/user.py

@@ -1,37 +1,44 @@
-from typing import Any, List
+from enum import IntEnum
+from typing import Any
 from pydantic import BaseModel
 from mcsmapi.models.instance import InstanceDetail, UserInstancesList
 
 
+class UserPermission(IntEnum):
+    BANNED = -1
+    USER = 1
+    ADMIN = 10
+
+
 class UserModel(BaseModel):
     """用户信息模型"""
 
-    """用户唯一标识符 (UUID)"""
     uuid: str = ""
-    """用户名"""
+    """用户唯一标识符 (UUID)"""
     userName: str = ""
-    """用户密码 (存储加密后的字符串)"""
+    """用户名"""
     passWord: str = ""
-    """密码类型 (0=默认类型)"""
+    """用户密码 (存储加密后的字符串)"""
     passWordType: int = 0
-    """密码盐值 (用于加密)"""
+    """密码类型 (0=默认类型)"""
     salt: str = ""
-    """用户权限级别 (1=用户, 10=管理员, -1=被封禁的用户)"""
-    permission: int = 1
-    """用户注册时间 (时间字符串格式)"""
+    """密码盐值 (用于加密)"""
+    permission: UserPermission = UserPermission.USER
+    """用户权限级别"""
     registerTime: str = ""
-    """用户最后登录时间 (时间字符串格式)"""
+    """用户注册时间 (时间字符串格式)"""
     loginTime: str = ""
-    """用户 API 密钥"""
+    """用户最后登录时间 (时间字符串格式)"""
     apiKey: str = ""
-    """是否为初始化用户 (系统内置用户)"""
+    """用户 API 密钥"""
     isInit: bool = False
-    """用户安全密钥 (可能用于额外的身份验证)"""
+    """是否为初始化用户 (系统内置用户)"""
     secret: str = ""
-    """是否启用双因素认证 (2FA)"""
+    """用户安全密钥 (可能用于额外的身份验证)"""
     open2FA: bool = False
+    """是否启用双因素认证 (2FA)"""
+    instances: list[UserInstancesList] = []
     """用户关联的实例列表"""
-    instances: List["UserInstancesList"] = []
 
     def delete(self) -> bool:
         """
@@ -56,16 +63,16 @@ class UserModel(BaseModel):
         """
         from mcsmapi.apis.user import User
 
-        updated_config = self.dict()
+        updated_config = self.model_dump()
         updated_config.update(config)
         # 过滤用户信息中不需要的字段
         user_config_dict = {
             key: updated_config[key]
-            for key in UserConfig.__fields__.keys()
+            for key in UserConfig.model_fields.keys()
             if key in updated_config
         }
 
-        user_config = UserConfig(**user_config_dict).dict()
+        user_config = UserConfig(**user_config_dict).model_dump()
 
         return User().update(self.uuid, user_config)
 
@@ -73,38 +80,38 @@ class UserModel(BaseModel):
 class SearchUserModel(BaseModel):
     """用户搜索结果"""
 
-    """匹配的用户总数"""
     total: int = 0
-    """当前页码"""
+    """匹配的用户总数"""
     page: int = 0
-    """每页返回的用户数量"""
+    """当前页码"""
     page_size: int = 0
-    """最大可用页数"""
+    """每页返回的用户数量"""
     max_page: int = 0
+    """最大可用页数"""
+    data: list[UserModel] = []
     """用户信息列表"""
-    data: List[UserModel] = []
 
 
 class UserConfig(BaseModel):
     """用户配置信息"""
 
-    """用户唯一标识符 (UUID)"""
     uuid: str
-    """用户名"""
+    """用户唯一标识符 (UUID)"""
     userName: str
-    """最后登录时间"""
+    """用户名"""
     loginTime: str
-    """注册时间"""
+    """最后登录时间"""
     registerTime: str
+    """注册时间"""
+    instances: list[InstanceDetail]
     """用户拥有的实例列表"""
-    instances: List[InstanceDetail]
-    """用户权限级别 (1=用户, 10=管理员, -1=被封禁的用户)"""
-    permission: int
-    """用户 API 密钥"""
+    permission: UserPermission
+    """用户权限级别"""
     apiKey: str
-    """是否为初始化用户 (系统内置用户)"""
+    """用户 API 密钥"""
     isInit: bool
-    """用户安全密钥 (可能用于额外的身份验证)"""
+    """是否为初始化用户 (系统内置用户)"""
     secret: str
-    """是否启用双因素认证 (2FA)"""
+    """用户安全密钥 (可能用于额外的身份验证)"""
     open2FA: bool
+    """是否启用双因素认证 (2FA)"""

mcsmapi/pool.py

@@ -12,3 +12,4 @@ class ApiPool(Enum):
     SERVICE = "api/service"
     FILE = "api/files"
     IMAGE = "api/environment"
+    LOG = "api/overview/operation_logs"

mcsmapi/request.py

@@ -1,59 +1,65 @@
 from typing import Any
 import requests
 import urllib.parse
+
+from mcsmapi.pool import ApiPool
 from .exceptions import MCSMError
 
 
 class Request:
-    mcsm_url = ""
-    timeout = 5
+    mcsm_url: str = ""
+    timeout: int = 5
     session = requests.Session()
-    apikey = None
-    token = None
+    apikey: str | None = None
+    token: str | None = None
 
     @classmethod
-    def set_mcsm_url(cls, url):
+    def set_mcsm_url(cls, url: str):
         """设置类级别的 mcsm_url"""
         cls.mcsm_url = url
 
     @classmethod
-    def set_timeout(cls, timeout):
+    def set_timeout(cls, timeout: int):
         """设置类级别的 timeout"""
         cls.timeout = timeout
 
     @classmethod
-    def set_apikey(cls, apikey):
+    def set_apikey(cls, apikey: str):
         """设置类级别的 apikey"""
         cls.apikey = apikey
 
     @classmethod
-    def set_token(cls, token):
+    def set_token(cls, token: str):
         """设置类级别的 token"""
         cls.token = token
 
     @classmethod
-    def __init__(cls, mcsm_url=None, timeout=None):
+    def __init__(cls, mcsm_url: str | None = None, timeout: int | None = None):
         """初始化时使用类变量，或者使用传入的参数覆盖默认值"""
         cls.mcsm_url = mcsm_url or cls.mcsm_url
         cls.timeout = timeout or cls.timeout
 
     @classmethod
-    def send(cls, method: str, endpoint: Any, params=None, data=None) -> Any:
+    def send(
+        cls,
+        method: str,
+        endpoint: str | ApiPool,
+        params: dict | None = None,
+        data: Any | None = None,
+    ) -> Any:
         """发送 HTTP 请求"""
         if params is None:
             params = {}
         if data is None:
             data = {}
-        if not isinstance(endpoint, str):
-            endpoint = str(endpoint)
+        if isinstance(endpoint, ApiPool):
+            endpoint = endpoint.value
 
         url = urllib.parse.urljoin(cls.mcsm_url, endpoint)
         if cls.apikey is not None:
             params["apikey"] = cls.apikey
-            data["apikey"] = cls.apikey
         if cls.token is not None:
             params["token"] = cls.token
-            data["token"] = cls.token
 
         response = cls.session.request(
             method.upper(),

{mcsmapi-0.1.5b2.dist-info → mcsmapi-0.1.7.dist-info}/METADATA

@@ -1,15 +1,17 @@
 Metadata-Version: 2.4
 Name: mcsmapi
-Version: 0.1.5b2
+Version: 0.1.7
 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>=2.0.0
 Dynamic: license-file
 
 # MCSM API
@@ -26,7 +28,13 @@ English|[Chinese Simplified](README_zh-cn.md)
 
 ## Documentation
 
-The documentation is not yet complete, if you need it, please visit [https://deepwiki.com/molanp/mcsmapi](https://deepwiki.com/molanp/mcsmapi)
+The documentation is not yet complete, if you need it, please visit [deepwiki-mcsmapi](https://deepwiki.com/molanp/mcsmapi)
+
+You can also find:  
+
+📄 Work-in-progress docs: [docs](docs)
+
+💡 Example: [example](example)
 
 ## Introduction
 
@@ -43,7 +51,7 @@ pip install mcsmapi
 ```
 
 If you need the latest build files (untested), please visit
-[Actions](https://github.com/molanp/mcsmapi/actions)
+[Actions](https://github.com/molanp/mcsmapi/actions/workflows/auto-build.yml)
 
 ## Supported Features
 

mcsmapi-0.1.7.dist-info/RECORD

@@ -0,0 +1,24 @@
+mcsmapi/__init__.py,sha256=TxBjQPMtwR_Eh0N7nZAoKinONAgnDsSbt47-cLvbeLk,1418
+mcsmapi/exceptions.py,sha256=mHsAHyoX9SiFDGBMEhesA_ao9hhZZ38EGTp97K7VDp8,184
+mcsmapi/pool.py,sha256=Xa1DvBdfn5zTZ-eB50BFbYxhKX8j-4vfus9QOGO_FQE,348
+mcsmapi/request.py,sha256=G6O4Q3oXidmauyraUgoMTkms5XFlY-iHPhZ3s0k9TmM,2743
+mcsmapi/apis/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+mcsmapi/apis/daemon.py,sha256=4kGWkVHsT7wgMGaTOei3daUe8qJ3_LGJ12hjq9j6OaE,2759
+mcsmapi/apis/file.py,sha256=uoO6PSlbSfleMQnopc4Ajmf_Z4dMN4IkunXBzv9rvvQ,10955
+mcsmapi/apis/image.py,sha256=Onb_yciTyybB4r2TxyvW04Z6-nnTSDO2HanhtRbA3m4,2968
+mcsmapi/apis/instance.py,sha256=RHvR7dyKgOlIuKbQzemWVXw17jEUmLILZ0J-gFu6538,11117
+mcsmapi/apis/overview.py,sha256=MqLmEyLh3i9VsQRFn7WI_02yRBt6eqZvusOkhHFIgFw,518
+mcsmapi/apis/user.py,sha256=XdoIgT9j87fhp0FPO4UusPYDPf59WlvzRaeLAdMhikM,3022
+mcsmapi/models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+mcsmapi/models/common.py,sha256=2KiqbGiBRuipIoeSNPH9_p7sGyKOy406JtBhWR4K0dQ,598
+mcsmapi/models/daemon.py,sha256=FTt10oYFnGXG1WAXMJ4roPGLCX5R5U3YGIzeEu-2F4E,4344
+mcsmapi/models/file.py,sha256=0BltWCHZC0Mlic1_xaPRys0HyNdKScGNxui4_tzREUI,5976
+mcsmapi/models/image.py,sha256=jlEbLF6uEwBTRShOGI0vWYN7WAZyJoiMa1gw_UjKINw,5447
+mcsmapi/models/instance.py,sha256=vixAknesy-lop5BI8lKIHaDsSpa5xJtycAfX3zz0PGs,8810
+mcsmapi/models/overview.py,sha256=kGDvHtsur1iA0wbeT-QkZPf04wkmo6YsrFSLtGZpsd0,4583
+mcsmapi/models/user.py,sha256=OnELhHdnoJYvfJUH55QwAHsZDu1vwigYIjAdbZFyMnk,3182
+mcsmapi-0.1.7.dist-info/licenses/LICENSE,sha256=bMKDPsvaybvY-4TTlSZtCXPPtxb7KPpDVqXgDA8Ogo0,1068
+mcsmapi-0.1.7.dist-info/METADATA,sha256=7lsyKuG4FBPFGpyb0L3CpuNcW4zvuBpPECOEjhBzZEg,2989
+mcsmapi-0.1.7.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+mcsmapi-0.1.7.dist-info/top_level.txt,sha256=8MUYHd1Or4cbSCd93IaqLA72w0weEuKieopVwIfVlWo,8
+mcsmapi-0.1.7.dist-info/RECORD,,

{mcsmapi-0.1.5b2.dist-info → mcsmapi-0.1.7.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.4.0)
+Generator: setuptools (80.9.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

mcsmapi-0.1.5b2.dist-info/RECORD

@@ -1,23 +0,0 @@
-mcsmapi/__init__.py,sha256=Xm0gsQMecMZwD1of9UGOkTan25l_jqrWkG-7mg0YgF4,1514
-mcsmapi/exceptions.py,sha256=mHsAHyoX9SiFDGBMEhesA_ao9hhZZ38EGTp97K7VDp8,184
-mcsmapi/pool.py,sha256=CoOYbyECp4FoXkzwFN7WgtS3vgZtvWO8e93i18vhOEI,308
-mcsmapi/request.py,sha256=5mCzKgrh4OPFKvBo22kIDpX_D1zqCza1nglYUeGWveg,2618
-mcsmapi/apis/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-mcsmapi/apis/daemon.py,sha256=2Se5ViwaePg6_CGI9qKeI823FMF0qzlemn2yCt92SPs,4488
-mcsmapi/apis/file.py,sha256=Qh3kOtU2mj9PS2nN4s6WufZ149pM0sbkM37aG-LlY5A,10778
-mcsmapi/apis/image.py,sha256=UwVH2LPfPBEADZuoSyyiMrlEc9LL858Z3oidRPaKrvs,2908
-mcsmapi/apis/instance.py,sha256=zibACXlhsMAWW5QjvGCFO5iN0wNEVlnecdnFvLeQTUg,10986
-mcsmapi/apis/overview.py,sha256=4bS3RGSykdQ1JyBTM-I9na6v0SCijEG1CN-WxqabfUo,625
-mcsmapi/apis/user.py,sha256=CBLNWxxNfvnmzoMa1YV3Q33POitYDGyN-hRORoe2JEc,2968
-mcsmapi/models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-mcsmapi/models/daemon.py,sha256=EV0nlUe6pUETbLIoUGn2HPWoNYClIyS2ABrRA70IjQk,5079
-mcsmapi/models/file.py,sha256=m75zhMkBA7KQm-870Ph3DfE9unSlOLWgMmwdl8H-vSc,6097
-mcsmapi/models/image.py,sha256=pjwSJ79rYMuDTLlazevpjqdnnc0Mqvea9bp-BepUhio,5484
-mcsmapi/models/instance.py,sha256=oNXw0q3FDTu2bG_crWPgUtLXxM2yL7eRwo9H2RFzmDA,8850
-mcsmapi/models/overview.py,sha256=yRERCPRA3vBceKjISBClngvmKaQlo0HowC859nm15Nc,2859
-mcsmapi/models/user.py,sha256=sduOS8MWoxUfvTseK7nShuBOYzei3dEM8eP45PuIZ3g,3130
-mcsmapi-0.1.5b2.dist-info/licenses/LICENSE,sha256=bMKDPsvaybvY-4TTlSZtCXPPtxb7KPpDVqXgDA8Ogo0,1068
-mcsmapi-0.1.5b2.dist-info/METADATA,sha256=IFV6TW-2aLuZydebLlPN1mSRbzsFCtRpRAbWa7kaDlc,2805
-mcsmapi-0.1.5b2.dist-info/WHEEL,sha256=DnLRTWE75wApRYVsjgc6wsVswC54sMSJhAEd4xhDpBk,91
-mcsmapi-0.1.5b2.dist-info/top_level.txt,sha256=8MUYHd1Or4cbSCd93IaqLA72w0weEuKieopVwIfVlWo,8
-mcsmapi-0.1.5b2.dist-info/RECORD,,