codosdk 1.0.26__tar.gz → 1.0.28__tar.gz

{codosdk-1.0.26 → codosdk-1.0.28}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: codosdk
-Version: 1.0.26
+Version: 1.0.28
 Summary: CODO项目的Python SDK
 Home-page: https://github.com/ss1917/codo_sdk/
 Author: shenshuo

{codosdk-1.0.26 → codosdk-1.0.28}/codosdk.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: codosdk
-Version: 1.0.26
+Version: 1.0.28
 Summary: CODO项目的Python SDK
 Home-page: https://github.com/ss1917/codo_sdk/
 Author: shenshuo

{codosdk-1.0.26 → codosdk-1.0.28}/setup.py

@@ -9,7 +9,7 @@ desc   : CODO SDK
 import sys
 from setuptools import setup, find_packages
 
-VERSION = '1.0.26'
+VERSION = '1.0.28'
 
 if sys.version_info < (2, 7) or (3, 0) <= sys.version_info < (3, 6):
     print('This program requires at least Python 2.7 or 3.6 to run.')

codosdk-1.0.28/websdk2/api_set.py

@@ -0,0 +1,57 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+"""
+Version : 0.0.1
+Contact : 191715030@qq.com
+Author  : shenshuo
+Date    : 2025/02/12 17:56
+Desc    : API集合
+"""
+
+from .tools import singleton
+from .apis import AdminAPIS, TaskAPIS, KerriganAPIS, AdminV4APIS, CMDBAPIS, AgentAPIS, NoticeAPIS
+
+
+@singleton
+class ConstAPIS(AdminAPIS, TaskAPIS, KerriganAPIS, AdminV4APIS, CMDBAPIS, AgentAPIS, NoticeAPIS):
+    """
+    集合所有常用 API 配置的常量类，继承了各个 API 模块的接口配置。
+
+    提供了对 API 配置项的只读管理，并且对每个新增属性值进行校验。
+    """
+
+    def __init__(self):
+        pass
+
+    def __setattr__(self, name: str, value: dict) -> None:
+
+        """
+        自定义属性设置方法，确保 API 配置项的合法性。
+
+        校验条件：
+        1. 不允许重新绑定常量。
+        2. 属性值必须是字典格式。
+        3. 必须包含 'url' 和 'description' 字段。
+
+        Args:
+            name (str): 属性名称
+            value (dict): 属性值，必须为字典格式并包含必要字段
+        """
+
+        if name in self.__dict__:
+            raise TypeError(f"Cannot rebind constant '{name}'.")
+
+        if not isinstance(value, dict):
+            raise TypeError(f"Value for '{name}' must be a dictionary.")
+
+        # 确保包含 'url' 和 'description' 字段
+        if 'url' not in value:
+            raise TypeError(f"Value for '{name}' must contain 'url'.")
+
+        if 'description' not in value:
+            raise TypeError(f"Value for '{name}' must contain 'description'.")
+
+        self.__dict__[name] = value
+
+
+api_set = ConstAPIS()

{codosdk-1.0.26 → codosdk-1.0.28}/websdk2/utils/__init__.py

@@ -8,101 +8,181 @@ Desc    :
 """
 
 import json
+import logging
 import os
 import smtplib
 import socket
 import time
 import uuid
 from datetime import datetime
-from email.mime.multipart import MIMEMultipart
+from typing import List, Union
 from email.mime.text import MIMEText
+from email.mime.multipart import MIMEMultipart
 
 from ..consts import const
 
 
-class SendMail(object):
-    def __init__(self, mail_host, mail_port, mail_user, mail_password, mail_ssl=False, mail_tls=False):
+class SendMail:
+    def __init__(self, mail_host: str, mail_port: int, mail_user: str, mail_password: str, mail_ssl: bool = False,
+                 mail_tls: bool = False):
         """
+        初始化邮件发送客户端
+
         :param mail_host:     SMTP主机
         :param mail_port:     SMTP端口
         :param mail_user:     SMTP账号
         :param mail_password: SMTP密码
-        :param mail_ssl:      SSL=True, 如果SMTP端口是465，通常需要启用SSL，  如果SMTP端口是587，通常需要启用TLS
+        :param mail_ssl:      是否启用SSL加密，如果SMTP端口是465，通常需要启用SSL
+        :param mail_tls:      是否启用TLS加密，如果SMTP端口是587，通常需要启用TLS
         """
         self.mail_host = mail_host
         self.mail_port = mail_port
-        self.__mail_user = mail_user
-        self.__mail_password = mail_password
+        self.mail_user = mail_user
+        self.__mail_password = mail_password  # 使用单下划线，表示这是一个受保护的属性
         self.mail_ssl = mail_ssl
         self.mail_tls = mail_tls
 
-    def send_mail(self, to_list, subject, content, subtype='plain', att=None):
+    def send_mail(self, to_list: Union[str, List[str]], subject: str, content: str, subtype: str = 'plain',
+                  att: Union[str, None] = None):
         """
-        :param to_list:  收件人，多收件人半角逗号分割， 必填
-        :param subject:  标题， 必填
-        :param content:  内容， 必填
-        :param subtype:  格式，默认：plain, 可选html
-        :param att:      附件，支持单附件，选填
+        发送邮件
+
+        :param to_list:  收件人列表，可以是单个邮箱地址字符串，也可以是多个邮箱地址的列表，必填
+        :param subject:  邮件标题，必填
+        :param content:  邮件内容，必填
+        :param subtype:  邮件内容格式，默认为plain，可选html
+        :param att:      附件路径，支持单个附件，选填
         """
+
+        if isinstance(to_list, list):
+            to_list = ','.join(to_list)  # 将列表转换为逗号分隔的字符串
+
         msg = MIMEMultipart()
-        msg['Subject'] = subject  ## 标题
-        msg['From'] = self.__mail_user  ## 发件人
-        msg['To'] = to_list  # 收件人，必须是一个字符串
-        # 邮件正文内容
+        msg['Subject'] = subject
+        msg['From'] = self.mail_user
+        msg['To'] = to_list
+
         msg.attach(MIMEText(content, subtype, 'utf-8'))
+
         if att:
             if not os.path.isfile(att):
-                raise FileNotFoundError('{0} file does not exist'.format(att))
+                raise FileNotFoundError(f'{att} 文件不存在')
+            try:
+                with open(att, 'rb') as f:
+                    file_data = f.read()
 
-            dirname, filename = os.path.split(att)
-            # 构造附件1，传送当前目录下的 test.txt 文件
-            att1 = MIMEText(open(att, 'rb').read(), 'base64', 'utf-8')
-            att1["Content-Type"] = 'application/octet-stream'
-            # 这里的filename可以任意写，写什么名字，邮件中显示什么名字
-            att1["Content-Disposition"] = 'attachment; filename="{0}"'.format(filename)
-            msg.attach(att1)
+                filename = os.path.basename(att)
+                attachment = MIMEText(file_data.decode('utf-8'), 'base64', 'utf-8')
+                attachment['Content-Type'] = 'application/octet-stream'
+                attachment['Content-Disposition'] = f'attachment; filename="{filename}"'
+                msg.attach(attachment)
+            except Exception as err:
+                logging.error(f"发送附件出错 {err}")
 
         try:
-            if self.mail_ssl:
-                '''SSL加密方式，通信过程加密，邮件数据安全, 使用端口465'''
-                # print('Use SSL SendMail')
-                server = smtplib.SMTP_SSL(host=self.mail_host)
-                server.connect(self.mail_host, self.mail_port)  # 连接服务器
-                server.login(self.__mail_user, self.__mail_password)  # 登录操作
-                server.sendmail(self.__mail_user, to_list.split(','), msg.as_string())
-                server.close()
-            elif self.mail_tls:
-                # print('Use TLS SendMail')
-                '''使用TLS模式'''
-                server = smtplib.SMTP()
-                server.connect(self.mail_host, self.mail_port)  # 连接服务器
-                server.starttls()
-                server.login(self.__mail_user, self.__mail_password)  # 登录操作
-                server.sendmail(self.__mail_user, to_list.split(','), msg.as_string())
-                server.close()
-                return True
-            else:
-                '''使用普通模式'''
-                server = smtplib.SMTP()
-                server.connect(self.mail_host, self.mail_port)  # 连接服务器
-                server.login(self.__mail_user, self.__mail_password)  # 登录操作
-                server.sendmail(self.__mail_user, to_list.split(','), msg.as_string())
-                server.close()
-                return True
+            with self._get_server() as server:
+                server.sendmail(self.mail_user, to_list.split(','), msg.as_string())
+            return True
         except Exception as e:
-            print(str(e))
+            logging.error(f'邮件发送失败: {e}')
             return False
 
+    def _get_server(self):
+        if self.mail_ssl:
+            server = smtplib.SMTP_SSL(self.mail_host, self.mail_port)
+        elif self.mail_tls:
+            server = smtplib.SMTP(self.mail_host, self.mail_port)
+            server.starttls()
+        else:
+            server = smtplib.SMTP(self.mail_host, self.mail_port)
+
+        server.login(self.mail_user, self.__mail_password)
+        return server
+
+
+# class SendMail(object):
+#     def __init__(self, mail_host, mail_port, mail_user, mail_password, mail_ssl=False, mail_tls=False):
+#         """
+#         :param mail_host:     SMTP主机
+#         :param mail_port:     SMTP端口
+#         :param mail_user:     SMTP账号
+#         :param mail_password: SMTP密码
+#         :param mail_ssl:      SSL=True, 如果SMTP端口是465，通常需要启用SSL，  如果SMTP端口是587，通常需要启用TLS
+#         """
+#         self.mail_host = mail_host
+#         self.mail_port = mail_port
+#         self.__mail_user = mail_user
+#         self.__mail_password = mail_password
+#         self.mail_ssl = mail_ssl
+#         self.mail_tls = mail_tls
+#
+#     def send_mail(self, to_list, subject, content, subtype='plain', att=None):
+#         """
+#         :param to_list:  收件人，多收件人半角逗号分割， 必填
+#         :param subject:  标题， 必填
+#         :param content:  内容， 必填
+#         :param subtype:  格式，默认：plain, 可选html
+#         :param att:      附件，支持单附件，选填
+#         """
+#         msg = MIMEMultipart()
+#         msg['Subject'] = subject  ## 标题
+#         msg['From'] = self.__mail_user  ## 发件人
+#         msg['To'] = to_list  # 收件人，必须是一个字符串
+#         # 邮件正文内容
+#         msg.attach(MIMEText(content, subtype, 'utf-8'))
+#         if att:
+#             if not os.path.isfile(att):
+#                 raise FileNotFoundError('{0} file does not exist'.format(att))
+#
+#             dirname, filename = os.path.split(att)
+#             # 构造附件1，传送当前目录下的 test.txt 文件
+#             att1 = MIMEText(open(att, 'rb').read(), 'base64', 'utf-8')
+#             att1["Content-Type"] = 'application/octet-stream'
+#             # 这里的filename可以任意写，写什么名字，邮件中显示什么名字
+#             att1["Content-Disposition"] = 'attachment; filename="{0}"'.format(filename)
+#             msg.attach(att1)
+#
+#         try:
+#             if self.mail_ssl:
+#                 '''SSL加密方式，通信过程加密，邮件数据安全, 使用端口465'''
+#                 # print('Use SSL SendMail')
+#                 server = smtplib.SMTP_SSL(host=self.mail_host)
+#                 server.connect(self.mail_host, self.mail_port)  # 连接服务器
+#                 server.login(self.__mail_user, self.__mail_password)  # 登录操作
+#                 server.sendmail(self.__mail_user, to_list.split(','), msg.as_string())
+#                 server.close()
+#             elif self.mail_tls:
+#                 # print('Use TLS SendMail')
+#                 '''使用TLS模式'''
+#                 server = smtplib.SMTP(host=self.mail_host)
+#                 server.connect(self.mail_host, self.mail_port)  # 连接服务器
+#                 server.starttls()
+#                 server.login(self.__mail_user, self.__mail_password)  # 登录操作
+#                 server.sendmail(self.__mail_user, to_list.split(','), msg.as_string())
+#                 server.close()
+#                 return True
+#             else:
+#                 '''使用普通模式'''
+#                 server = smtplib.SMTP()
+#                 server.connect(self.mail_host, self.mail_port)  # 连接服务器
+#                 server.login(self.__mail_user, self.__mail_password)  # 登录操作
+#                 server.sendmail(self.__mail_user, to_list.split(','), msg.as_string())
+#                 server.close()
+#                 return True
+#         except Exception as e:
+#             print(str(e))
+#             return False
+#
 
 def mail_login(user, password, mail_server='smtp.exmail.qq.com'):
-    ### 模拟登录来验证邮箱
+    # 模拟登录来验证邮箱
     try:
         server = smtplib.SMTP()
         server.connect(mail_server)
         server.login(user, password)
         return True
     except Exception as e:
-        print(user, e)
+        logging.error(f"{user}邮箱认证出错：{e}")
         return False
 
 

codosdk-1.0.26/websdk2/api_set.py

@@ -1,43 +0,0 @@
-#!/usr/bin/env python
-# -*- coding: utf-8 -*-
-"""
-Version : 0.0.1
-Contact : 191715030@qq.com
-Author  : shenshuo
-Date    : 2019/12/12 17:56
-Desc    : API集合
-"""
-
-from .tools import singleton
-from .apis import AdminAPIS, TaskAPIS, KerriganAPIS, AdminV4APIS, CMDBAPIS, AgentAPIS, NoticeAPIS
-
-
-@singleton
-class ConstAPIS(AdminAPIS, TaskAPIS, KerriganAPIS, AdminV4APIS, CMDBAPIS, AgentAPIS, NoticeAPIS):
-    def __init__(self):
-        pass
-
-    def __setattr__(self, name, value):
-        if name in self.__dict__:
-            raise TypeError("Can't rebind const (%s)" % name)
-
-        if not isinstance(value, dict):
-            raise TypeError("Value must be in dict format")
-
-        if not value.get('url'):
-            raise TypeError("Value must have url")
-
-        if not value.get('description'):
-            raise TypeError("Value must have description")
-
-        # body_data = value.get('body')
-        # if body_data is not None and not isinstance(body_data, (dict, list)):
-        #     try:
-        #         json.loads(body_data)
-        #     except (TypeError, ValueError):
-        #         raise TypeError("Body data cannot be loaded as JSON")
-
-        self.__dict__[name] = value
-
-
-api_set = ConstAPIS()