pytbox 0.1.2__py3-none-any.whl → 0.1.3__py3-none-any.whl

pytbox/base.py

@@ -12,6 +12,8 @@ from pytbox.win.ad import ADClient
 from pytbox.network.meraki import Meraki
 from pytbox.utils.env import get_env_by_os_environment
 from pytbox.vmware import VMwareClient
+from pytbox.pyjira import PyJira
+from pytbox.mail.client import MailClient
 
 config = load_config_by_file(path='/workspaces/pytbox/tests/alert/config_dev.toml', oc_vault_id=os.environ.get('oc_vault_id'))
 
@@ -73,4 +75,12 @@ vmware_test = VMwareClient(
     password=config['vmware']['test']['password'],
     version=config['vmware']['test']['version'],
     proxies=config['vmware']['test']['proxies']
-)
+)
+
+pyjira = PyJira(
+    base_url=config['jira']['base_url'],
+    token=config['jira']['token']
+)
+
+mail_163 = MailClient(mail_address=config['mail']['163']['mail_address'], password=config['mail']['163']['password'])
+mail_qq = MailClient(mail_address=config['mail']['qq']['mail_address'], password=config['mail']['qq']['password'])

pytbox/database/victoriametrics.py

@@ -73,6 +73,16 @@ class VictoriaMetrics:
     def check_ping_result(self, target: str, last_minute: int=10, env: str='prod', dev_file: str='') -> ReturnResponse:
         '''
         检查ping结果
+
+        Args:
+            target (str): 目标地址
+            last_minute (int, optional): 最近多少分钟. Defaults to 10.
+            env (str, optional): 环境. Defaults to 'prod'.
+            dev_file (str, optional): 开发文件. Defaults to ''.
+
+        Returns:
+            ReturnResponse: 
+                code = 0 正常, code = 1 异常, code = 2 没有查询到数据, 建议将其判断为正常
         '''
         if target:
             # 这里需要在字符串中保留 {}，同时插入 target，可以用双大括号转义

pytbox/feishu/endpoints.py

@@ -254,9 +254,9 @@ class MessageEndpoint(Endpoint):
             body=payload
         )
         if r.code == 0:
-            return ReturnResponse(code=0, message=f"{message_id} 回复 emoji [{emoji_type}] 成功")
+            return ReturnResponse(code=0, msg=f"{message_id} 回复 emoji [{emoji_type}] 成功")
         else:
-            return ReturnResponse(code=1, message=f"{message_id} 回复 emoji [{emoji_type}] 失败")
+            return ReturnResponse(code=1, msg=f"{message_id} 回复 emoji [{emoji_type}] 失败")
 
 class BitableEndpoint(Endpoint):
     
@@ -432,10 +432,10 @@ class BitableEndpoint(Endpoint):
             resp = self.parent.request(path=f'/bitable/v1/apps/{app_token}/tables/{table_id}/records/{record_id}',
                                         method='PUT',
                                         body=payload)
-            return ReturnResponse(code=resp.code, message=f"记录已存在, 进行更新", data=resp.data)
+            return ReturnResponse(code=resp.code, msg=f"记录已存在, 进行更新", data=resp.data)
         else:
             resp = self.add_record(app_token, table_id, fields)
-            return ReturnResponse(code=resp.code, message=f"记录不存在, 进行创建", data=resp.data)
+            return ReturnResponse(code=resp.code, msg=f"记录不存在, 进行创建", data=resp.data)
 
     def query_name_by_record_id(self, app_token: str=None, table_id: str=None, field_names: list=None, record_id: str='', name: str=''):
         response = self.query_record(app_token=app_token, table_id=table_id, field_names=field_names)
@@ -967,9 +967,9 @@ class ExtensionsEndpoint(Endpoint):
                                    body=payload)
         if response.code == 0:
             if get == 'open_id':
-                return ReturnResponse(code=0, message=f'根据用户输入的 {user_input}, 获取用户信息成功', data=response.data['user_list'][0]['user_id'])
+                return ReturnResponse(code=0, msg=f'根据用户输入的 {user_input}, 获取用户信息成功', data=response.data['user_list'][0]['user_id'])
         else:
-            return ReturnResponse(code=response.code, message=f"获取时失败, 报错请见 data 字段", data=response.data)
+            return ReturnResponse(code=response.code, msg=f"获取时失败, 报错请见 data 字段", data=response.data)
     
     def format_rich_text(self, text: str, color: Literal['red', 'green', 'yellow', 'blue'], bold: bool=False):
         if bold:

pytbox/mail/client.py

@@ -1,45 +1,11 @@
 #!/usr/bin/env python3
 
 
-from dataclasses import dataclass
-from typing import Generator, Literal
-
+from contextlib import contextmanager
 import yagmail
-from imbox import Imbox
-from imap_tools import MailBox, AND, MailMessageFlags
-from nb_log import get_logger
-
-from src.library.onepassword import my1p
-
-
-log = get_logger('src.library.mail.client')
-
-
-@dataclass
-class MailDetail:
-    """
-    邮件详情数据类。
-    
-    Attributes:
-        uid: 邮件唯一标识符
-        send_from: 发件人邮箱地址
-        send_to: 收件人邮箱地址列表
-        cc: 抄送人邮箱地址列表
-        subject: 邮件主题
-        body_plain: 纯文本正文
-        body_html: HTML格式正文
-        attachment: 附件完整保存路径列表
-    """
-    uid: str=None
-    send_from: str=None
-    send_to: list=None
-    date: str=None
-    cc: list=None
-    subject: str=None
-    body_plain: str=None
-    body_html: str=None
-    attachment: list=None
-    has_attachments: bool=False
+from imap_tools import MailBox, MailMessageFlags, AND
+from .mail_detail import MailDetail
+from ..utils.response import ReturnResponse
 
 
 class MailClient:
@@ -47,114 +13,93 @@ class MailClient:
     _summary_
     '''
     def __init__(self, 
-                 send_mail_address: Literal['service@tyun.cn', 'alert@tyun.cn', 'houmingming@tyun.cn', 'houmdream@163.com', 'houm01@foxmail.com'] = 'service@tyun.cn',
-                 authorization_code: bool=False,
+                 mail_address: str=None,
                  password: str=None
                 ):
         
-        self.mail_address = send_mail_address
-        
-        if password:
-            self.password = password
-        else:
-            if authorization_code:
-                self.password = my1p.get_item_by_title(title=send_mail_address)['授权码']
-            else:
-                self.password = my1p.get_item_by_title(title=send_mail_address)['password']
+        self.mail_address = mail_address
+        self.password = password
 
-        if '163.com' in send_mail_address:
+        if '163.com' in mail_address:
             self.smtp_address = 'smtp.163.com'
             self.imap_address = 'imap.163.com'
-            self.imbox_client = self._create_imbox_object(vendor='163')
-        elif 'foxmail.com' in send_mail_address:
+            # self.imbox_client = self._create_imbox_object()
+        elif 'foxmail.com' in mail_address:
             self.smtp_address = 'smtp.qq.com'
             self.imap_address = 'imap.qq.com'
-            self.imbox_client = self._create_imbox_object(vendor='qq')
+            
         else:
-            raise ValueError(f'不支持的邮箱地址: {send_mail_address}')
-
-        self.mailbox = MailBox(self.imap_address).login(self.mail_address, self.password)
+            raise ValueError(f'不支持的邮箱地址: {mail_address}')
+    
+    @contextmanager
+    def get_mailbox(self, readonly=False):
+        """
+        创建并返回一个已登录的 MailBox 上下文管理器。
+        
+        使用方式:
+            with self.get_mailbox() as mailbox:
+                # 使用 mailbox 进行操作
+                pass
         
-    def _create_imbox_object(self, vendor: Literal['aliyun', 'qq', '163']):
-        return Imbox(self.imap_address,
-                username=self.mail_address,
-                password=self.password,
-                ssl=True,
-                ssl_context=None,
-                starttls=False)
+        Args:
+            readonly (bool): 是否以只读模式打开邮箱，只读模式下不会将邮件标记为已读
+        
+        Yields:
+            MailBox: 已登录的邮箱对象
+        """
+        mailbox = MailBox(self.imap_address).login(self.mail_address, self.password)
+        if readonly:
+            # 以只读模式选择收件箱，防止邮件被标记为已读
+            mailbox.folder.set('INBOX', readonly=True)
+        try:
+            yield mailbox
+        finally:
+            mailbox.logout()
 
-    def send_mail(self, receiver: list=[], cc: list=['houmingming@tyun.cn'], subject: str='', contents: str='', attachments: list=[], tips: str=None):
+    def send_mail(self, receiver: list=None, cc: list=None, subject: str='', contents: str='', attachments: list=None, tips: str=None):
         '''
         _summary_
 
         Args:
-            receiver (list, optional): _description_. Defaults to [].
-            cc (list, optional): _description_. Defaults to ['houmingming@tyun.cn'].
+            receiver (list, optional): _description_. Defaults to None.
+            cc (list, optional): _description_. Defaults to None.
             subject (str, optional): _description_. Defaults to ''.
             contents (str, optional): _description_. Defaults to ''.
-            attachments (list, optional): _description_. Defaults to [].
+            attachments (list, optional): _description_. Defaults to None.
         '''
-        email_signature = """
-————————————————————————————————————————
-以专业成就客户 
-钛信（上海）信息科技有限公司
-Tai Xin（ShangHai) Information Technology Co.,Ltd.
-中国上海市浦东新区达尔文路88号半岛科技园21栋2楼
-Tel:400-920-0057
-Web:www.tyun.cn
-————————————————————————————————————————
-信息安全声明：本邮件包含信息归发件人所在组织所有，发件人所在组织对该邮件拥有所有权利。请接收者注意保密，未经发件人书面许可，不得向任何第三方组织和个人透露本邮件所含信息的全部或部分。以上声明仅适用于工作邮件。
-Information Security Notice: The information contained in this mail is solely property of the sender's organization. This mail communication is confidential. Recipients named above are obligated to maintain secrecy and are not permitted to disclose the contents of this communication to others.
-""" 
-        with yagmail.SMTP(user=self.mail_address, password=my1p.get_item_by_title(self.mail_address)['password'], port=465, host=self.smtp_address) as yag:
-            log.info(f'receiver: {receiver}, cc: {cc}, subject: {subject}, contents: {contents}, attachments: {attachments}')
+        with yagmail.SMTP(user=self.mail_address, password=self.password, port=465, host=self.smtp_address) as yag:
             try:
                 if tips:
-                    contents = contents + '\n' + '<p style="color: red;">本邮件为系统自动发送, 如有问题, 请联系 houmingming@tyun.cn</p>'
-
-                contents = contents + email_signature
+                    contents = contents + '\n' + '<p style="color: red;">本邮件为系统自动发送</p>'
                 yag.send(to=receiver, cc=cc, subject=subject, contents=contents, attachments=attachments)
-                log.info('发送成功!!!')
                 return True
             except Exception as e:
-                log.error(f'发送失败, 报错: {e}')
                 return False
+            
+    def get_mail_list(self, seen: bool=False, readonly: bool=True):
+        '''
+        获取邮件
 
-    def get_mail_list(self, is_read: bool=False) -> Generator:
-        with MailBox(self.imap_address).login(self.mail_address, self.password) as mailbox:
-            for msg in mailbox.fetch(criteria=AND(seen=is_read)):
-                # 处理附件
-                attachment_list = []
-                for att in msg.attachments:
-                    att_dict = {}
-                    att_dict['filename'] = att.filename
-                    att_dict['payload'] = att.payload
-                    att_dict['size'] = att.size
-                    att_dict['content_id'] = att.content_id
-                    att_dict['content_type'] = att.content_type
-                    att_dict['content_disposition'] = att.content_disposition
-                    # att_dict['part'] = att.part
-                    att_dict['size'] = att.size
-                    attachment_list.append(att_dict)
-                
-                if attachment_list:
-                    is_has_attachments = True
-                else:
-                    is_has_attachments = False
+        Args:
+            seen (bool, optional): 默认获取未读邮件, 如果为 True, 则获取已读邮件
+            readonly (bool, optional): 是否以只读模式获取邮件，默认为 True，防止邮件被标记为已读
 
+        Yields:
+            MailDetail: 邮件详情
+        '''
+        with self.get_mailbox(readonly=readonly) as mailbox:
+            for msg in mailbox.fetch(AND(seen=seen)):
                 yield MailDetail(
                     uid=msg.uid,
-                    send_from=msg.from_,
-                    send_to=msg.to,
+                    sent_from=msg.from_,
+                    sent_to=msg.to,
                     date=msg.date,
                     cc=msg.cc,
                     subject=msg.subject,
                     body_plain=msg.text,
-                    body_html=msg.html,
-                    has_attachments=is_has_attachments,
-                    attachment=attachment_list
-                )
-
+                    body_html=msg.html
+                )     
+            
     def mark_as_read(self, uid):
         """
         标记邮件为已读。
@@ -163,13 +108,12 @@ Information Security Notice: The information contained in this mail is solely pr
             uid (str): 邮件的唯一标识符
         """
         try:
-            # 使用 imap_tools 的 flag 方法标记邮件为已读
-            # 第一个参数是 uid，第二个参数是要设置的标志，第三个参数 True 表示添加标志
-            self.mailbox.flag(uid, [MailMessageFlags.SEEN], True)
-            # log.info(f'标注邮件{uid}为已读')
+            with self.get_mailbox() as mailbox:
+                # 使用 imap_tools 的 flag 方法标记邮件为已读
+                # 第一个参数是 uid，第二个参数是要设置的标志，第三个参数 True 表示添加标志
+                mailbox.flag(uid, [MailMessageFlags.SEEN], True)
         except Exception as e:
-            log.error(f'标记邮件{uid}为已读失败: {e}')
-            raise
+            return ReturnResponse(code=1, msg='邮件删除失败', data=e)
     
     def delete(self, uid):
         """
@@ -179,14 +123,15 @@ Information Security Notice: The information contained in this mail is solely pr
             uid (str): 邮件的唯一标识符
         """
         try:
-            # 使用 imap_tools 的 delete 方法删除邮件
-            self.mailbox.delete(uid)
-            log.info(f'删除邮件{uid}')
+            with self.get_mailbox() as mailbox:
+                # 使用 imap_tools 的 delete 方法删除邮件
+                mailbox.delete(uid)
+                # log.info(f'删除邮件{uid}')
         except Exception as e:
-            log.error(f'删除邮件{uid}失败: {e}')
+            # log.error(f'删除邮件{uid}失败: {e}')
             raise
     
-    def move(self, uid: str, destination_folder: str) -> None:
+    def move(self, uid: str, destination_folder: str) -> ReturnResponse:
         """
         移动邮件到指定文件夹。
 
@@ -198,24 +143,25 @@ Information Security Notice: The information contained in this mail is solely pr
             destination_folder (str): 目标文件夹名称。
 
         Returns:
-            None
+            ReturnResponse: 移动邮件结果
 
         Raises:
             Exception: 移动过程中底层 imap 库抛出的异常。
         """
         try:
-            # 使用 imap_tools 的 move 方法移动邮件
-            self.mailbox.move(uid, destination_folder)
-            log.info(f'邮件{uid}已移动到{destination_folder}')
+            with self.get_mailbox() as mailbox:
+                # 使用 imap_tools 的 move 方法移动邮件
+                mailbox.move(uid, destination_folder)
+                return ReturnResponse(code=0, msg=f'邮件 {uid} 移动到 {destination_folder} 成功', data=None)
         except Exception as e:
-            log.error(f'移动邮件{uid}到{destination_folder}失败: {e}')
-            raise
+            return ReturnResponse(code=1, msg=f'邮件 {uid} 移动到 {destination_folder} 失败', data=e)
+
+    def get_folder_list(self):
+        '''
+        获取文件夹列表
+        '''
+        with self.get_mailbox() as mailbox:
+            return ReturnResponse(code=0, msg='获取文件夹列表成功', data=mailbox.folder.list())
 
 if __name__ == '__main__':
-    # ali_mail = MailClient(send_mail_address='houmingming@tyun.cn')
-    # mail = MailClient(send_mail_address='houmingming@tyun.cn')
-    # mail = MailClient(send_mail_address='houmdream@163.com', authorization_code=True)
-    # mail = MailClient(send_mail_address='houm01@foxmail.com', password=my1p.get_item_by_title('QQ'))
-    # 对于阿里云邮箱，使用兼容方法
-    pass
-    # mail.get_mail_list(attachment=True, attachment_path='/tmp')
+    pass

pytbox/mail/mail_detail.py

@@ -0,0 +1,30 @@
+#!/usr/bin/env python3
+
+
+from dataclasses import dataclass
+
+@dataclass
+class MailDetail:
+    """
+    邮件详情数据类。
+    
+    Attributes:
+        uid: 邮件唯一标识符
+        send_from: 发件人邮箱地址
+        send_to: 收件人邮箱地址列表
+        cc: 抄送人邮箱地址列表
+        subject: 邮件主题
+        body_plain: 纯文本正文
+        body_html: HTML格式正文
+        attachment: 附件完整保存路径列表
+    """
+    uid: str=None
+    sent_from: str=None
+    sent_to: list=None
+    date: str=None
+    cc: list=None
+    subject: str=None
+    body_plain: str=None
+    body_html: str=None
+    attachment: list=None
+    has_attachments: bool=False

pytbox/pyjira.py

@@ -0,0 +1,558 @@
+#!/usr/bin/env python3
+
+import re
+from typing import Literal, Optional, List
+
+from requests.auth import HTTPBasicAuth
+import requests
+
+from .utils.response import ReturnResponse
+
+
+class PyJira:
+    """JIRA API客户端类
+    
+    提供JIRA操作的封装方法，支持任务创建、更新、查询等功能。
+    建议使用OAuth 2.0认证以提高安全性。
+    """
+    
+    def __init__(self, 
+                 base_url: str=None,
+                 proxies: dict=None,
+                 token: str=None,
+                 username: str=None,
+                 password: str=None,
+                 timeout: int=10
+            ) -> None:
+        '''
+        _summary_
+
+        Args:
+            base_url (str, optional): _description_. Defaults to None.
+            proxies (dict, optional): _description_. Defaults to None.
+            token (str, optional): _description_. Defaults to None.
+            username (str, optional): _description_. Defaults to None.
+            password (str, optional): _description_. Defaults to None.
+        '''
+        self.base_url = base_url
+        self.rest_version = 3
+        self.proxies = None
+
+        if 'atlassian.net' in self.base_url:
+            self.deploy_type = 'cloud'
+            self.rest_version = 3
+        else:
+            self.deploy_type = 'datacenter'
+            self.rest_version = 2
+
+        if self.deploy_type == 'cloud':
+            self.headers = {
+                "Accept": "application/json",
+                "Content-Type": "application/json",
+                "Authorization": f"Basic {token}"
+            }
+        else:
+            self.headers = {
+                "Accept": "application/json",
+                "Content-Type": "application/json",
+                "Authorization": f"Bearer {token}"
+            }
+            self.auth = HTTPBasicAuth(username, password)
+        
+        self.timeout = timeout
+        # 使用 requests.Session 统一管理连接与 headers（不改变现有硬编码与参数传递逻辑）
+        self.session = requests.Session()
+        self.session.headers.update(self.headers)
+        
+    def get_project_boards(self, project_key: Literal['TEST'] = 'TEST') -> list:
+        """获取指定项目的看板列表
+        
+        Args:
+            project_key: 项目key，例如 'OPS'
+            
+        Returns:
+            list: 看板列表
+        """
+        boards = self.jira.boards(projectKeyOrID=project_key)
+        for board in boards:
+            print(board.name)
+        return boards
+
+    def issue_get(self, issue_id_or_key: str, account_id: bool = False) -> ReturnResponse:
+        """获取指定JIRA任务
+        
+        Args:
+            issue_key: 任务key，例如 'TEST-50'
+            account_id: 是否返回账户ID，默认为False
+            
+        Returns:
+            dict: 任务信息或账户ID
+        """
+        url = f"{self.base_url}/rest/api/{self.rest_version}/issue/{issue_id_or_key}"
+        r = self.session.get(url, headers=self.headers, timeout=self.timeout)
+        
+        # 移除所有 key 以 customfield_ 开头且后面跟数字的字段
+        fields = r.json()['fields']
+        keys_to_remove = [k for k in fields if k.startswith('customfield_') and k[12:].isdigit()]
+        for k in keys_to_remove:
+            fields.pop(k)
+        
+        if r.status_code == 200:
+            return ReturnResponse(code=0, msg=f'获取 issue [{issue_id_or_key}] 成功', data=fields)
+        else:
+            return ReturnResponse(code=1, msg=f'获取 issue [{issue_id_or_key}] 失败')
+
+    def issue_get_by_key(self, issue_id_or_key:str='', get_key: Literal['assignee', 'summary', 'description', 'status']=None):
+        '''
+        _summary_
+
+        Args:
+            issue_id_or_key (str, optional): _description_. Defaults to ''.
+            get_key: status 就是 transitions
+
+        Raises:
+            ValueError: _description_
+
+        Returns:
+            _type_: _description_
+        '''
+        r = self.issue_get(issue_id_or_key=issue_id_or_key)
+        if r.code == 0:
+            if get_key:
+                # print(get_key)
+                # print(r.data['assignee'])
+                try:
+                    return r.data[get_key]
+                except KeyError as e:
+                    return r.data
+        else:
+            raise ValueError(f"{issue_id_or_key} 的 {get_key} 未查找到")
+            
+
+    def issue_create(self, 
+                    project_id: int = 10000, 
+                    summary: Optional[str] = None, 
+                    description: str = None, 
+                    description_adf: bool=True,
+                    issue_type: Literal['任务'] = '任务', 
+                    priority: Literal['Highest', 'High', 'Medium', 'Low', 'Lowest'] = 'Medium',
+                    reporter: dict=None,
+                    assignee: dict={},
+                    parent_key: Optional[str] = None) -> ReturnResponse:
+        """创建一个新的JIRA任务
+        
+        Args:
+            project_id: 项目ID，默认为 10000
+            summary: 任务标题
+            description: 任务描述，默认为空字符串，支持普通文本，会自动转换为ADF格式
+            issue_type: 任务类型，默认为 'Task'
+            priority: 优先级，默认为 'Medium'
+            parent_key: 父任务key，如果提供则创建子任务，默认为None
+            reporter(dict): { "name": reporter}, : {"id" : xx}
+            assignee: {"accountId": "xxx"}
+            
+        Returns:
+            Response: 创建结果，包含任务信息或错误信息
+        """
+        url = f"{self.base_url}/rest/api/{self.rest_version}/issue"
+        data = {
+            "fields": {
+                'project': { "id": project_id},
+                'summary': summary,
+                'issuetype': { "name": issue_type},
+                'priority': { "name": priority},
+                # 'reporter': reporter
+            }
+        }
+        if assignee:
+            data['fields']['assignee'] = assignee
+        if description:
+            # 将普通文本转换为ADF格式
+            if description_adf:
+                data['fields']['description'] = self.text_to_adf(description)
+            else:
+                data['fields']['description'] = description
+            
+        if parent_key:
+            data['fields']['parent'] = {"key": parent_key}
+    
+        if reporter:
+            if isinstance(reporter, str):
+                data['fields']['reporter'] = {"name": reporter}
+            else:
+                data['fields']['reporter'] = reporter
+
+        r = self.session.post(
+            url,
+            headers=self.headers,
+            json=data,
+            timeout=self.timeout,
+            proxies=self.proxies
+        )
+        if r.status_code == 201:
+            return ReturnResponse(code=0, msg=f'创建 issue [{summary}] 成功', data=r.json())
+        else:
+            return ReturnResponse(code=1, msg=f'创建 issue [{summary}] 失败, {r.text}')
+        
+
+    def issue_update(self, 
+                     issue_key: str, 
+                     summary: Optional[str] = None, 
+                     description: str = None, 
+                     issue_type: str = None,
+                     priority: Literal['Blocker', 'Critical', 'Major', 'Minor'] = None,
+                     labels: Optional[list[str]] = None,
+                     parent_key: str=None) -> dict:
+        """更新JIRA任务
+        
+        Args:
+            issue_key: 任务key，例如 'TEST-50'
+            summary: 任务标题，默认为None
+            description: 任务描述，默认为空字符串，支持普通文本，会自动转换为ADF格式
+            issue_type: 任务类型，默认为 'Task'
+            priority: 优先级，默认为 'Minor'
+            assignee: 分配人，默认为 'MingMing Hou'
+            status: 任务状态，默认为None
+            labels: 标签列表，默认为None
+            
+        Returns:
+            dict: 更新后的任务信息或错误信息
+        """
+        url = f"{self.base_url}/rest/api/{self.rest_version}/issue/{issue_key}"
+        data = { "fields": {} }
+        if summary:
+            data['fields']['summary'] = summary
+        if description is not None:
+            description = self.format_description(description)
+            # 将普通文本转换为ADF格式
+            data['fields']['description'] = self.text_to_adf(description)
+        if issue_type:
+            data['fields']['issuetype'] = issue_type
+        if priority:
+            data['fields']['priority'] = {"name": priority}
+        if labels:
+            data['fields']['labels'] = labels
+            
+        if parent_key:
+            data['fields']['parent'] = {"key": parent_key}
+        
+        # print(data)
+        r = self.session.put(url, headers=self.headers, json=data, timeout=self.timeout)
+        if r.status_code == 204:
+            return ReturnResponse(code=0, msg=f'更新 issue [{issue_key}] 成功', data=r.text)
+        else:
+            try:
+                error_data = r.json()
+                error_message = f'更新 issue [{issue_key}] 失败, status: {r.status_code}, 错误: {error_data}'
+            except:
+                error_message = f'更新 issue [{issue_key}] 失败, status: {r.status_code}, 响应: {r.text}'
+            return ReturnResponse(code=1, msg=error_message, data=r.text)
+
+    def issue_assign(self, issue_id_or_key: str='', name: str=None, display_name: str=None, account_id: str=None) -> ReturnResponse:
+        '''
+        _summary_
+
+        Args:
+            issue_id_or_key (str, optional): _description_. Defaults to ''.
+            name (str, optional): _description_. Defaults to None.
+            display_name (str, optional): _description_. Defaults to None.
+            account_id (str, optional): _description_. 侯明明: 612dbc1d1dbcd90069240013 包柿林: 712020:66dfa4a9-383e-4aa2-abdd-521adfccf967
+
+        Returns:
+            ReturnResponse: _description_
+        '''    
+        update = False
+        url = f"{self.base_url}/rest/api/{self.rest_version}/issue/{issue_id_or_key}/assignee"
+        data = {}
+        if name:
+            data["name"] = name
+            assignee_message = name
+            update = True
+            
+        if display_name:
+            data["displayName"] = display_name
+            assignee_message = display_name
+            update = True
+            
+        if account_id:
+            account_info = self.issue_get_by_key(issue_id_or_key=issue_id_or_key, get_key='assignee')
+            if account_info is None:
+                update = True
+            else:
+                current_account_id = account_info['accountId']
+                if current_account_id != account_id:
+                    update = True
+            
+            data["accountId"] = account_id
+            assignee_message = account_id
+
+        if update:
+            r = self.session.put(url, headers=self.headers, json=data, timeout=self.timeout)
+            if r.status_code == 204:
+                return ReturnResponse(code=0, msg=f'更新 issue [{issue_id_or_key}] 的分配人成功, 经办人被更新为 {assignee_message}', data=r.text)
+            return ReturnResponse(code=1, msg=f'更新 issue [{issue_id_or_key}] 的分配人失败, status code: {r.status_code}, 报错: {r.text}')
+        return ReturnResponse(code=0, msg=f'issue [{issue_id_or_key}] 的分配人已经为 {assignee_message}, 不需要更新')
+
+    def issue_comment_add(self, issue_key: str, comment: str) -> dict:
+        """添加JIRA任务评论
+        
+        Args:
+            issue_key: 任务key，例如 'TEST-50'
+            comment: 评论内容
+            
+        Returns:
+            dict: 评论信息
+        """
+        url = f"{self.base_url}/rest/api/{self.rest_version}/issue/{issue_key}/comment/"
+        comment_adf = self.text_to_adf(text=self.format_description(comment))
+        r = self.session.post(url, headers=self.headers, json={"body": comment_adf}, timeout=self.timeout)
+        if r.status_code == 201:
+            return ReturnResponse(code=0, msg=f'添加评论 [{comment}] 成功', data=r.json())
+        else:
+            return ReturnResponse(code=1, msg=f'添加评论 [{comment}] 失败, 返回值: {r.text}', data=r.json())
+    
+    def issue_search(self, jql: str, max_results: int = 50, fields: Optional[List[str]] = None) -> ReturnResponse:
+        """使用JQL搜索JIRA任务
+        
+        Args:
+            jql: JQL查询字符串
+            max_results: 最大返回结果数，默认50
+            fields: 需要返回的字段列表，默认返回所有字段
+            
+        Returns:
+            ReturnResponse: 包含任务列表的响应数据
+        """
+        url = f"{self.base_url}/rest/api/3/search"
+        
+        # 构建请求体
+        payload = {
+            "jql": jql,
+            "maxResults": max_results,
+            "startAt": 0
+        }
+        
+        # 如果指定了字段，添加到请求体中
+        if fields:
+            payload["fields"] = fields
+        
+        r = self.session.post(url, headers=self.headers, json=payload, timeout=self.timeout)
+        
+        if r.status_code == 200:
+            return ReturnResponse(code=0, msg='', data=r.json())
+        else:
+            return ReturnResponse(code=1, msg=f'获取 issue 失败, status code: {r.status_code}, 报错: {r.text}')
+
+    def get_boards(self) -> ReturnResponse:
+        """获取所有看板信息并打印
+        
+        使用REST API获取看板信息，主要用于调试和查看。
+        """
+        url = f"{self.base_url}/rest/agile/1.0/board"
+        response = self.session.get(url, headers=self.headers, timeout=self.timeout)
+        response.raise_for_status()
+        return ReturnResponse(code=0, msg='', data=response.json())
+ 
+    def get_issue_fields(self) -> ReturnResponse:
+        url = f"{self.base_url}/rest/api/3/field"
+        response = self.session.get(url, headers=self.headers, timeout=self.timeout)
+        response.raise_for_status()
+        return ReturnResponse(code=0, msg='', data=response.json())
+ 
+    def get_project(self, project_id_or_key: Literal['TEST']='TEST') -> ReturnResponse:
+        if self.deploy_type == 'cloud':
+            url = f"{self.base_url}/rest/api/3/project/{project_id_or_key}"
+        else:
+            url = f"{self.base_url}/rest/api/2/project"
+            
+        response = self.session.get(url, headers=self.headers, timeout=self.timeout)
+        if response.status_code == 401:
+            return ReturnResponse(code=1, msg=response.text)
+        else:
+            return ReturnResponse(code=0, msg='', data=response.json())
+
+    # def get_issue(self, issue_id_or_key: str) -> ReturnResponse:
+    #     url = f"{self.base_url}/rest/api/{self.rest_version}/issue/{issue_id_or_key}"
+    #     response = self.session.get(url, headers=self.headers, timeout=self.timeout)
+    #     if response.status_code == 200:
+    #         return ReturnResponse(code=0, msg=f'根据输入的 {issue_id_or_key} 成功获取到 issue', data=response.json())
+    #     else:
+    #         return ReturnResponse(code=1, msg=response.text)
+ 
+    def get_metadata_for_project_issue_types(self, project_id_or_key: Literal['TEST', 'MO', '10000']='TEST'):
+        url = f"{self.base_url}/rest/api/2/issue/createmeta/{project_id_or_key}/issuetypes"
+        response = self.session.get(url, headers=self.headers, timeout=self.timeout)
+        if response.status_code == 200:
+            return ReturnResponse(code=0, msg='', data=response.json())
+        else:
+            return ReturnResponse(code=1, msg=f"{response.status_code}: {response.text}")
+ 
+    def get_metadata_for_issue_type_used_for_create_issue(self, project_id_or_key: Literal['TEST', 'MO']='TEST', issue_type_id: Literal['10000']='10000'):
+        url = f"{self.base_url}/rest/api/{self.rest_version}/issue/createmeta/{project_id_or_key}/issuetypes/{issue_type_id}"
+        r = self.session.get(url, headers=self.headers, timeout=self.timeout)
+        return r
+    
+    def get_user(self, username: str=None, key: str=None):
+        url = f"{self.base_url}/rest/api/{self.rest_version}/user"
+        r = self.session.get(url, headers=self.headers, params={'username': username}, timeout=self.timeout)
+        return r
+    
+    def get_issue_property(self, issue_id_or_key):
+        url = f"{self.base_url}/rest/api/2/issue/{issue_id_or_key}/properties"
+        r = self.session.get(url, headers=self.headers, timeout=self.timeout)
+        return r
+    
+    def find_user(self, query: str) -> ReturnResponse:
+        '''
+        查找用户
+
+        Args:
+            query (str): 建议输入用户的邮箱
+
+        Returns:
+            _type_: 
+        '''
+        url = f"{self.base_url}/rest/api/{self.rest_version}/user/search"
+        r = self.session.get(url, headers=self.headers, params={'query': query}, timeout=self.timeout)
+        if r.status_code == 200:
+            return ReturnResponse(code=0, msg=f'查找到 {len(r.json())} 个用户', data=r.json()[0])
+        else:
+            return ReturnResponse(code=1, msg=f'获取用户失败, status code: {r.status_code}, 报错: {r.text}')
+    
+    def get_issue_transitions(self, issue_id_or_key) -> ReturnResponse:
+        url = f"{self.base_url}/rest/api/{self.rest_version}/issue/{issue_id_or_key}/transitions"
+        r = self.session.get(url, headers=self.headers, timeout=self.timeout)
+        if r.status_code == 200:
+            return ReturnResponse(code=0, msg='', data=r.json())
+        else:
+            return ReturnResponse(code=1, msg=f'获取 issue [{issue_id_or_key}] 的 transitions 失败, status code: {r.status_code}, 报错: {r.text}')
+  
+    def get_issue_transitions_by_name(self, issue_id_or_key, name) -> ReturnResponse:
+        r = self.get_issue_transitions(issue_id_or_key=issue_id_or_key)
+        for transition in r.data['transitions']:
+            if transition['name'] == name:
+                return ReturnResponse(code=0, msg=f'获取 issue [{issue_id_or_key}] 的 transitions 成功, 返回值: {transition["id"]}', data=transition['id'])
+        raise ValueError(f'获取 issue [{issue_id_or_key}] 的 transitions 失败, 没有找到状态为 {name} 的 transition')
+
+    def issue_transition(self, issue_id_or_key, transition_name) -> ReturnResponse:
+        update = False
+        status = self.issue_get_by_key(issue_id_or_key=issue_id_or_key, get_key='status')
+        if status:
+            if transition_name != status['name']:
+                update = True
+        if update:
+            url = f"{self.base_url}/rest/api/{self.rest_version}/issue/{issue_id_or_key}/transitions"
+            data = {
+                "transition": {
+                    "id": self.get_issue_transitions_by_name(issue_id_or_key=issue_id_or_key, name=transition_name).data
+                }
+            }
+            r = self.session.post(url, headers=self.headers, json=data, timeout=self.timeout)
+            if r.status_code == 204:
+                return ReturnResponse(code=0, msg=f'更新 issue [{issue_id_or_key}] 的状态成功, 状态被更新为 {transition_name}', data=r.text)
+            else:
+                return ReturnResponse(code=1, msg=f'更新 issue [{issue_id_or_key}] 的状态失败, status code: {r.status_code}, 报错: {r.text}')
+        else:
+            return ReturnResponse(code=0, msg=f'issue [{issue_id_or_key}] 的状态已经为 {status["name"]}, 不需要更新')
+
+    def format_description(self, description):
+        '''
+        格式化描述
+        '''
+        if not description:
+            return ""
+        
+        new_description = description
+        
+        # 内容清理正则表达式
+        CONTENT_CLEANUP_PATTERNS = [
+            r'\*\*工作历时\*\*: \d+小时',
+            r'\*\*工作历时\*\*:.*小时',
+            r'!\[image\]\(.*?\)',
+            r'!\[file\]\(.*?\)',
+            r'\[Jira Link\]\(.*?\)',
+            r'bear://x-callback-url/open-note\?id=.*'
+        ] 
+
+        for pattern in CONTENT_CLEANUP_PATTERNS:
+            new_description = re.sub(pattern, '', new_description)
+        return new_description.strip()
+
+    def text_to_adf(self, text: str) -> dict:
+        """
+        将普通文本转换为Atlassian Document Format (ADF)格式。
+        
+        Args:
+            text: 要转换的文本内容
+            
+        Returns:
+            dict: ADF格式的文档对象
+        """
+        if not text:
+            return {
+                "type": "doc",
+                "version": 1,
+                "content": [
+                    {
+                        "type": "paragraph",
+                        "content": [
+                            {
+                                "type": "text",
+                                "text": ""
+                            }
+                        ]
+                    }
+                ]
+            }
+        
+        # 将文本按行分割
+        lines = text.split('\n')
+        content = []
+        
+        for line in lines:
+            if line.strip():  # 非空行
+                paragraph_content = [
+                    {
+                        "type": "text",
+                        "text": line
+                    }
+                ]
+                content.append({
+                    "type": "paragraph",
+                    "content": paragraph_content
+                })
+            else:  # 空行，添加换行符
+                if content:  # 如果前面有内容，添加换行
+                    content.append({
+                        "type": "paragraph",
+                        "content": [
+                            {
+                                "type": "text",
+                                "text": ""
+                            }
+                        ]
+                    })
+        
+        # 如果没有内容，至少添加一个空段落
+        if not content:
+            content = [
+                {
+                    "type": "paragraph",
+                    "content": [
+                        {
+                            "type": "text",
+                            "text": ""
+                        }
+                    ]
+                }
+            ]
+        
+        return {
+            "type": "doc",
+            "version": 1,
+            "content": content
+        }
+
+ 
+if __name__ == '__main__':
+    pass
+    

{pytbox-0.1.2.dist-info → pytbox-0.1.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pytbox
-Version: 0.1.2
+Version: 0.1.3
 Summary: A collection of Python integrations and utilities (Feishu, Dida365, VictoriaMetrics, ...)
 Author-email: mingming hou <houm01@foxmail.com>
 License-Expression: MIT
@@ -16,6 +16,8 @@ Requires-Dist: rich>=12.0.0
 Requires-Dist: jinja2>=3.0.0
 Requires-Dist: toml>=0.10.0
 Requires-Dist: ldap3>=2.9.1
+Requires-Dist: imap-tools>=1.11.0
+Requires-Dist: yagmail>=0.15.293
 Provides-Extra: dev
 Requires-Dist: pytest; extra == "dev"
 Requires-Dist: black; extra == "dev"

{pytbox-0.1.2.dist-info → pytbox-0.1.3.dist-info}/RECORD

@@ -1,8 +1,10 @@
-pytbox/base.py,sha256=2tJoUPdMrZ6dYLTgteQisLinFGKRtkUKD-Nzs4eFokk,2533
+pytbox/base.py,sha256=XGl2d87FLVp8ILhFF4P_ZVTZGSzxejV3PoyKUp4UCkQ,2937
 pytbox/cli.py,sha256=N775a0GK80IT2lQC2KRYtkZpIiu9UjavZmaxgNUgJhQ,160
 pytbox/dida365.py,sha256=pUMPB9AyLZpTTbaz2LbtzdEpyjvuGf4YlRrCvM5sbJo,10545
+pytbox/excel.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 pytbox/onepassword_connect.py,sha256=nD3xTl1ykQ4ct_dCRRF138gXCtk-phPfKYXuOn-P7Z8,3064
 pytbox/onepassword_sa.py,sha256=08iUcYud3aEHuQcUsem9bWNxdXKgaxFbMy9yvtr-DZQ,6995
+pytbox/pyjira.py,sha256=TMy34Rtu7OXRA8wpUuLsFeyIQfRNUn2ed2no00L8YSE,22470
 pytbox/vmware.py,sha256=WiH67_3-VCBjXJuh3UueOc31BdZDItiZhkeuPzoRhw4,3975
 pytbox/alert/alert_handler.py,sha256=FePPQS4LyGphSJ0QMv0_pLWaXxEqsRlcTKMfUjtsNfk,5048
 pytbox/alert/ping.py,sha256=g36X0U3U8ndZqfpVIcuoxJJ0X5gST3I_IwjTQC1roHA,779
@@ -41,16 +43,17 @@ pytbox/cli/formatters/__init__.py,sha256=4o85w4j-A-O1oBLvuE9q8AFiJ2C9rvB3MIKsy5V
 pytbox/cli/formatters/output.py,sha256=h5WhZlQk1rjmxEj88Jy5ODLcv6L5zfGUhks_3AWIkKU,5455
 pytbox/common/__init__.py,sha256=3JWfgCQZKZuSH5NCE7OCzKwq82pkyop9l7sH5YSNyfU,122
 pytbox/database/mongo.py,sha256=CSpHC7iR-M0BaVxXz5j6iXjMKPgXJX_G7MrjCj5Gm8Q,3478
-pytbox/database/victoriametrics.py,sha256=sVqLegKW-pR3CRdG3I2Z0z2xR8V-3iXbQbaHUe7uF5k,4975
+pytbox/database/victoriametrics.py,sha256=wTTsCOMpUpia8Bhp3clpFrUo3ow0T822MnZMxJnXRVM,5392
 pytbox/feishu/client.py,sha256=kwGLseGT_iQUFmSqpuS2_77WmxtHstD64nXvktuQ3B4,5865
-pytbox/feishu/endpoints.py,sha256=KmLB7yq0mpJgkWsTgGCufrejrPGV6JP0_p1GE6Pp4yI,40264
+pytbox/feishu/endpoints.py,sha256=z3nPOZPC2JGDJlO7SusWBpRA33hZZ4Z-GBhI6F8L_u4,40240
 pytbox/feishu/errors.py,sha256=79qFAHZw7jDj3gnWAjI1-W4tB0q1_aSfdjee4xzXeuI,1179
 pytbox/feishu/helpers.py,sha256=jhSkHiUw4822QBXx2Jw8AksogZdakZ-3QqvC3lB3qEI,201
 pytbox/feishu/typing.py,sha256=3hWkJgOi-v2bt9viMxkyvNHsPgrbAa0aZOxsZYg2vdM,122
 pytbox/log/logger.py,sha256=7ZisXRxLb_MVbIqlYHWoTbj1EA0Z4G5SZvITlt1IKW8,7416
 pytbox/log/victorialog.py,sha256=gffEiq38adv9sC5oZeMcyKghd3SGfRuqtZOFuqHQF6E,4139
 pytbox/mail/alimail.py,sha256=ap6K6kmKTjqbHlfecYBi-EZtOY1iQ8tCilP8oqUz21Q,4621
-pytbox/mail/client.py,sha256=zr51tW3URhaA1EzrXZ85Go3QIHGz_0aMszmGSFcJFLk,9065
+pytbox/mail/client.py,sha256=6HeKpChHGjTCYGBgQcfAhWlU_wh9wtO-bjP6TU38pGM,6120
+pytbox/mail/mail_detail.py,sha256=6u8DK-7WzYPSuX6TdicSCh2Os_9Ou6Rn9xc6WRvv85M,699
 pytbox/network/meraki.py,sha256=054E3C5KzAuXs9aPalvdAOUo6Hc5aOKZSWUaVbPquy4,6112
 pytbox/utils/env.py,sha256=gD2-NyL3K3Vg1B1eGeD1hRtlSHPGgF8Oi9mchuQL6_o,646
 pytbox/utils/load_config.py,sha256=R4pGerBinbewsym41hQ8Z-I5I7gepuEKODjIrli4C08,5043
@@ -60,8 +63,8 @@ pytbox/utils/response.py,sha256=kXjlwt0WVmLRam2eu1shzX2cQ7ux4cCQryaPGYwle5g,1247
 pytbox/utils/richutils.py,sha256=OT9_q2Q1bthzB0g1GlhZVvM4ZAepJRKL6a_Vsr6vEqo,487
 pytbox/utils/timeutils.py,sha256=XbK2KB-SVi7agNqoQN7i40wysrZvrGuwebViv1Cw-Ok,20226
 pytbox/win/ad.py,sha256=-3pWfL3dElz-XoO4j4M9lrgu3KJtlhrS9gCWJBpafAU,1147
-pytbox-0.1.2.dist-info/METADATA,sha256=D0y3X1i5U5ljy9iccpb7aSWtRKM-TUm_W_HBHUxrh9k,6252
-pytbox-0.1.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-pytbox-0.1.2.dist-info/entry_points.txt,sha256=YaTOJ2oPjOiv2SZwY0UC-UA9QS2phRH1oMvxGnxO0Js,43
-pytbox-0.1.2.dist-info/top_level.txt,sha256=YADgWue-Oe128ptN3J2hS3GB0Ncc5uZaSUM3e1rwswE,7
-pytbox-0.1.2.dist-info/RECORD,,
+pytbox-0.1.3.dist-info/METADATA,sha256=go1IkU9GPVADsgEj5_yqgU5ueyLpU66-82AHS6S0JGw,6319
+pytbox-0.1.3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+pytbox-0.1.3.dist-info/entry_points.txt,sha256=YaTOJ2oPjOiv2SZwY0UC-UA9QS2phRH1oMvxGnxO0Js,43
+pytbox-0.1.3.dist-info/top_level.txt,sha256=YADgWue-Oe128ptN3J2hS3GB0Ncc5uZaSUM3e1rwswE,7
+pytbox-0.1.3.dist-info/RECORD,,