ezKit 1.0.0__py3-none-any.whl

ezKit/mongo.py

@@ -0,0 +1,62 @@
+from loguru import logger
+from pymongo import MongoClient
+
+from . import utils
+
+
+class Mongo():
+
+    mongo = MongoClient()
+
+    def __init__(self, mongo_url=None):
+        ''' Initiation '''
+        if mongo_url != None:
+            self.mongo = MongoClient(mongo_url)
+
+    def close(self):
+        try:
+            self.mongo.close()
+        except Exception as e:
+            logger.exception(e)
+
+    def connect_test(self, debug: bool = False):
+        info = 'MongoDB连接测试'
+        try:
+            logger.info(f'{info}[执行]')
+            self.mongo.server_info()
+            logger.success(f'{info}[成功]')
+            return True
+        except Exception as e:
+            logger.error(f'{info}[失败]')
+            logger.exception(e) if utils.v_true(debug, bool) else next
+            return False
+
+    def collection(self, database, name):
+        return self.mongo[database][name]
+
+    def collection_insert(self, database, collection, data, drop=None):
+        db_collection = self.mongo[database][collection]
+        info = '插入数据'
+        try:
+            logger.info(f'{info}[执行]')
+            # 是否删除 collection
+            if drop == True:
+                # 删除 collection
+                db_collection.drop()
+            # 插入数据
+            if utils.v_true(data, dict):
+                # 插入一条数据
+                result = db_collection.insert_one(data)
+            elif utils.v_true(data, list):
+                # 插入多条数据
+                result = db_collection.insert_many(data)
+            else:
+                logger.error(f'{info}[失败]')
+                logger.error('数据类型错误')
+                return False
+            logger.success(f'{info}[成功]')
+            return result
+        except Exception as e:
+            logger.error(f'{info}[失败]')
+            logger.exception(e)
+            return False

ezKit/plots.py

@@ -0,0 +1,155 @@
+import matplotlib.patches as mpatches
+import matplotlib.pyplot as plt
+import numpy as np
+import pandas as pd
+from loguru import logger
+
+
+def bar(data={}, index=[], image={}, **kwargs):
+    '''
+    标准条形图
+    https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.plot.html
+    https://matplotlib.org/stable/api/pyplot_summary.html
+    '''
+    try:
+        _df = pd.DataFrame(data, index=index)
+        '''
+        title: 标题
+        kind: 类型
+        figsize: 图片大小, 以 100 为基数, 这里输出的图片为 2000 x 2000
+        width: 图形条宽度
+        dpi: 清晰度
+        bbox_inches='tight' 去除图片周边空白
+        '''
+        _ax = _df.plot(title=image.get('title'), kind=image.get('kind', 'bar'), figsize=image.get('size', (10, 10)), width=image.get('width', 0.8))
+        _ax.set_xlim(image.get('xlim'))
+        _ax.set_ylim(image.get('ylim'))
+        _ax.figure.savefig(image.get('path', 'image.png'), dpi=image.get('dpi', 300), bbox_inches='tight')
+        return True
+
+    except Exception as e:
+        logger.exception(e)
+        return False
+
+def bar_cover(data=[], index=[], image={}, **kwargs):
+    '''
+    重叠条形图
+    https://pandas.pydata.org/docs/reference/api/pandas.DataFrame.plot.html
+    https://matplotlib.org/stable/api/pyplot_summary.html
+    df.plot.bar() 和 df.plot.barh() 中 stacked=True 的效果是叠加, 即所有图层堆积拼接在一起
+    这里需要的效果是图层重叠, 即按从大到小的顺序依次重叠
+    但是 pandas 没有好的处理方法, 为了实现重叠效果, 以下使用设置 ax 处理
+    '''
+
+    try:
+
+        # 创建数据实例
+        _df = pd.DataFrame({item['key']: item['data'] for item in data}, index)
+
+        '''
+        设置图形类型、颜色、宽度
+        注意顺序: 从大到小排列
+        因为图层是叠加的, 所以后面的图层会覆盖前面的图层
+        如果后面图层的较大, 就会前面较小的图层, 所以把图层较大的放在前面, 图层较小的放在后面
+        _, ax = plt.subplots()
+        df.MAX.plot(kind='barh', ax=ax, color='#E74C3C', width=0.8)
+        df.MID.plot(kind='barh', ax=ax, color='#3498DB', width=0.8)
+        df.MIN.plot(kind='barh', ax=ax, color='#2ECC71', width=0.8)
+        '''
+        _, _ax = plt.subplots()
+        for i in data:
+            _df[i['key']].plot(kind=i.get('kind', 'bar'), ax=_ax, color=i.get('color'), width=i.get('width', 0.8))
+
+        '''
+        设置 Label
+        即图片右上角的说明信息, 这里也有顺序, 会按照 handles 中的顺序显示
+        https://stackoverflow.com/a/69897921
+        patch_max = mpatches.Patch(color='#E74C3C', label='Max')
+        patch_mid = mpatches.Patch(color='#3498DB', label='Mid')
+        patch_min = mpatches.Patch(color='#2ECC71', label='Min')
+        plt.legend(handles=[patch_max, patch_mid, patch_min])
+        '''
+        plt.legend(handles=[mpatches.Patch(color=i.get('color'), label=i.get('label')) for i in data])
+
+        # 设置标题
+        plt.title(image.get('title'))
+
+        # 设置上下限
+        plt.xlim(image.get('xlim'))
+        plt.ylim(image.get('ylim'))
+
+        # 创建图片实例
+        _fig = plt.gcf()
+
+        # 设置图片大小
+        # https://www.zhihu.com/question/37221233
+        _fig.set_size_inches(image.get('size', (10, 10)))
+
+        # 保存图片
+        # bbox_inches='tight' 去除图片周边空白
+        _fig.savefig(image.get('path', 'image.png'), dpi=image.get('dpi', 300), bbox_inches='tight')
+
+        # Close a figure window
+        plt.close()
+
+        # Return
+        return True
+
+    except Exception as e:
+        logger.exception(e)
+        return False
+
+def bar_extend(data=[], index=[], image={}, **kwargs):
+    '''
+    扩展的条形图
+    https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.plot.html
+    https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.bar.html
+    https://matplotlib.org/stable/gallery/lines_bars_and_markers/barchart.html
+    https://stackoverflow.com/a/68107816
+    '''
+    try:
+
+        _x = np.arange(len(index))
+
+        _bar_width = image.get('width', 0.8)
+
+        _fig, _ax = plt.subplots()
+
+        _rects = _ax.bar(_x, data, _bar_width, label=image.get('label'), color=image.get('color'))
+
+        # Set base
+        _ax.set_title(image.get('title'))
+        _ax.set_xlabel(image.get('xlabel'))
+        _ax.set_ylabel(image.get('ylabel'))
+        _ax.set_xticks(_x, index)
+
+        # Set view limits
+        _ax.set_xlim(image.get('xlim'))
+        _ax.set_ylim(image.get('ylim'))
+
+        # 设置图例
+        _ax.legend()
+
+        # bar 顶部显示 value
+        _ax.bar_label(_rects, padding=3)
+
+        # 自动调整参数, 使图形适合图形区域
+        _fig.tight_layout()
+
+        # 图片大小
+        # 默认 300px 为 1 个单位
+        # 默认 1920px * 1440px, 即 6.4 * 4.8
+        _fig.set_size_inches(image.get('size', (6.4, 4.8)))
+
+        # 生成图片文件
+        # bbox_inches='tight' 去除图片周边空白
+        _fig.savefig(image.get('path', 'image.png'), dpi=image.get('dpi', 300), bbox_inches='tight')
+
+        # Close a figure window
+        plt.close()
+
+        return True
+
+    except Exception as e:
+        logger.exception(e)
+        return False

ezKit/redis.py

@@ -0,0 +1,51 @@
+import redis as RedisClient
+from loguru import logger
+
+from . import utils
+
+
+class Redis(object):
+
+    # https://redis.readthedocs.io/en/stable/_modules/redis/client.html#Redis
+    # https://github.com/redis/redis-py#client-classes-redis-and-strictredis
+    # redis-py 3.0 drops support for the legacy Redis client class.
+    # StrictRedis has been renamed to Redis and an alias named StrictRedis is provided so that users previously using StrictRedis can continue to run unchanged.
+    # redis-py 3.0 之后只有一个 Redis, StrictRedis 是 Redis 的别名
+    # 这里修改以下参数: host, port, socket_timeout, socket_connect_timeout, charset
+    redis = RedisClient.Redis()
+
+    def __init__(self, arguments=None):
+        '''Initiation'''
+        if utils.v_true(arguments, str):
+            self.redis = RedisClient.from_url(arguments)
+        elif utils.v_true(arguments, dict):
+            self.redis = RedisClient.Redis(**arguments)
+        else:
+            pass
+
+    def connect_test(self):
+        info = 'Redis连接测试'
+        try:
+            logger.info(f'{info}......')
+            self.redis.ping()
+            logger.success(f'{info}[成功]')
+            return True
+        except Exception as e:
+            logger.error(f'{info}[失败]')
+            logger.exception(e)
+            return False
+
+    def flush(self, all=None):
+        info = 'Redis数据清理'
+        try:
+            logger.info(f'{info}......')
+            if all == True:
+                self.redis.flushall()
+            else:
+                self.redis.flushdb()
+            logger.success(f'{info}[成功]')
+            return True
+        except Exception as e:
+            logger.error(f'{info}[失败]')
+            logger.exception(e)
+            return False

ezKit/reports.py

@@ -0,0 +1,274 @@
+from . import files, utils
+
+'''
+reports.logout()
+
+    生成报告完成以后, 退出 Zabbix
+
+return _image
+
+    返回图片信息, 发邮件时使用
+'''
+
+class Reports(object):
+
+    # Zabbix Instance
+    _zabbix = None
+
+    # Files Instance
+    _files = None
+
+    # Image Object
+    _image_dir = '.'
+    _image_name_prefix = 'image'
+
+    def __init__(self, zabbix, markdown_file, html_file, image_dir, image_name_prefix):
+        ''' Initiation '''
+        self._zabbix = zabbix
+        self._files = files.files(markdown_file, html_file)
+        self._image_dir = image_dir
+        self._image_name_prefix = image_name_prefix
+
+    def generic(
+        self,
+        pieces=None,
+        hosts=None,
+        time_from=None,
+        time_till=None,
+        item_keys=None,
+        data_type=None,
+        data_proc=None,
+        title=None,
+        description=None,
+        number_type=None,
+        number_unit=None,
+        number_handling=None,
+        table_header_title='Host',
+        table_header_data='Data',
+        sort_by_ip=None,
+        image_cid=None,
+        image_label=None,
+        image_kind=None
+    ):
+
+        _history = []
+
+        if utils.v_true(item_keys, str):
+            _history = utils.retry(10, self._zabbix.get_history_by_item_key, hosts, time_from, time_till, item_keys, data_type)
+
+        if utils.v_true(item_keys, list):
+            for _item_key in item_keys:
+                _history_slice = utils.retry(10, self._zabbix.get_history_by_item_key, hosts, time_from, time_till, _item_key, data_type)
+                if _history_slice != None:
+                    if callable(data_proc) == True:
+                        _history_slice = data_proc(_history_slice)
+                    _history += _history_slice
+
+        if _history != None:
+
+            _files_func = self._files.multiple_pieces
+
+            if pieces == 'single':
+
+                _files_func = self._files.single_piece
+
+                for _data in _history:
+                    if len(_data['history']) > 0:
+                        _history_last = max(_data['history'], key=lambda i: i['clock'])
+                        _data['history'] = _history_last
+
+            _image = {
+                'cid': '{}'.format(image_cid),
+                'path': '{}/{}_{}.png'.format(self._image_dir, self._image_name_prefix, image_cid),
+                'label': image_label,
+                'kind': image_kind
+            }
+
+            _files_result = _files_func(
+                title=title,
+                description=description,
+                data=_history,
+                image=_image,
+                number_type=number_type,
+                number_unit=number_unit,
+                number_handling=number_handling,
+                table_header_title=table_header_title,
+                table_header_data=table_header_data,
+                sort_by_ip=sort_by_ip
+            )
+
+            if _files_result == True:
+                return _image
+            else:
+                return None
+
+        else:
+
+            return None
+
+    def system_interface(self, hosts, interfaces, time_from, time_till, direction='in'):
+        ''' System Interface '''
+
+        _direction_name = 'Received'
+        _direction_alias = 'received'
+        _direction_info = '接收数据'
+
+        if direction == 'out':
+            _direction_name = 'Sent'
+            _direction_alias = 'sent'
+            _direction_info = '发送数据'
+
+        _history = utils.retry(10, self._zabbix.get_history_by_interface, hosts, interfaces, time_from, time_till, direction)
+
+        if utils.v_true(_history, list):
+
+            _image = {
+                'cid': 'system_interface_'.format(_direction_alias),
+                'path': '{}/{}_system_interface_{}.png'.format(self._image_dir, self._image_name_prefix, _direction_alias)
+            }
+
+            _ = self._files.multiple_pieces(
+                title='System Interface {}'.format(_direction_name),
+                description='说明: 网卡**{}**的速度'.format(_direction_info),
+                data=_history,
+                image=_image,
+                number_type='int',
+                number_unit='Kbps',
+                number_handling=utils.divisor_1000,
+                sort_by_ip=True
+            )
+
+            if _ == True:
+                return _image
+            else:
+                return None
+
+        else:
+
+            return None
+
+    def base_system(self, hosts, time_from, time_till, interfaces=None):
+
+        # Images
+        _images = []
+
+        # System CPU utilization
+        _image = self.generic(
+            hosts=hosts,
+            time_from=time_from,
+            time_till=time_till,
+            item_keys='system.cpu.util',
+            data_type=0,
+            title='System CPU utilization',
+            description='说明: 系统 CPU 使用率',
+            number_type='float',
+            number_unit='%',
+            sort_by_ip=True,
+            image_cid='system_cpu_utilization'
+        )
+        if _image != None:
+            _images.append(_image)
+
+        # System Memory utilization
+        _image = self.generic(
+            hosts=hosts,
+            time_from=time_from,
+            time_till=time_till,
+            item_keys='vm.memory.utilization',
+            data_type=0,
+            title='System Memory utilization',
+            description='说明: 系统 内存 使用率',
+            number_type='float',
+            number_unit='%',
+            sort_by_ip=True,
+            image_cid='system_memory_utilization'
+        )
+        if _image != None:
+            _images.append(_image)
+
+        # System root partition utilization
+        _image = self.generic(
+            pieces='single',
+            hosts=hosts,
+            time_from=time_from,
+            time_till=time_till,
+            item_keys='vfs.fs.size[/,pused]',
+            data_type=0,
+            title='System root partition utilization',
+            description='说明: 系统 根目录(/) 使用率',
+            number_type='float',
+            number_unit='%',
+            table_header_data='Used',
+            sort_by_ip=True,
+            image_cid='system_root_partition_utilization',
+            image_label='Used (%)',
+            image_kind='barh'
+        )
+        if _image != None:
+            _images.append(_image)
+
+        if interfaces != None:
+
+            # System Interface Received
+            _image = self.system_interface(hosts, interfaces, time_from, time_till, 'in')
+            if _image != None:
+                _images.append(_image)
+
+            # System Interface Sent
+            _image = self.system_interface(hosts, interfaces, time_from, time_till, 'out')
+            if _image != None:
+                _images.append(_image)
+
+        return _images
+
+    def base_generic(self, hosts, time_from, time_till, items=None):
+
+        # Images
+        _images = []
+
+        if items != None:
+
+            for _item in items:
+
+                # CPU utilization
+                _image = self.generic(
+                    hosts=hosts,
+                    time_from=time_from,
+                    time_till=time_till,
+                    item_keys=_item['keys'][0],
+                    data_type=_item['types'][0],
+                    data_proc=_item.get('data_proc'),
+                    title='{} CPU utilization'.format(_item['name']),
+                    description='说明: {} CPU 使用率'.format(_item['name']),
+                    number_type='float',
+                    number_unit='%',
+                    table_header_title=_item.get('table_header_title', 'Host'),
+                    table_header_data=_item.get('table_header_data', 'Data'),
+                    sort_by_ip=True,
+                    image_cid='{}_cpu_utilization'.format(_item['alias'])
+                )
+                if _image != None:
+                    _images.append(_image)
+
+                # Memory used (RSS)
+                _image = self.generic(
+                    hosts=hosts,
+                    time_from=time_from,
+                    time_till=time_till,
+                    item_keys=_item['keys'][1],
+                    data_type=_item['types'][1],
+                    data_proc=_item.get('data_proc'),
+                    title='{} Memory used (RSS)'.format(_item['name']),
+                    description='说明: {} 内存 使用量'.format(_item['name']),
+                    number_type='int',
+                    number_unit='MB',
+                    number_handling=utils.divisor_square_1024,
+                    table_header_title=_item.get('table_header_title', 'Host'),
+                    table_header_data=_item.get('table_header_data', 'Data'),
+                    sort_by_ip=True,
+                    image_cid='{}_memory_used_rss'.format(_item['alias'])
+                )
+                if _image != None:
+                    _images.append(_image)
+
+        return _images

ezKit/sendemail.py

@@ -0,0 +1,146 @@
+'''
+https://stackoverflow.com/questions/882712/sending-html-email-using-python
+'''
+import smtplib
+from email.header import Header
+from email.mime.image import MIMEImage
+from email.mime.multipart import MIMEMultipart
+from email.mime.text import MIMEText
+from email.utils import formataddr, parseaddr
+
+from loguru import logger
+
+from . import utils
+
+
+def format_parse(s):
+    _name, _addr = parseaddr(s)
+    return formataddr((Header(_name, 'utf-8').encode(), _addr))
+
+def related_html(smtp=None, sender=None, recipients=None, subject=None, html_file=None, images=None):
+    '''
+    smtp SMTP信息
+
+        server SMTP地址
+        port   SMTP端口
+        ssl    是否使用SSL
+
+    sender 发件人信息
+
+        name     发件人名称
+        address  发件人邮箱地址
+        password 发件人邮箱密码(SMTP)
+
+    recipients 收件人列表
+    subject 邮件主题
+    html_file HTML文件
+
+    images 图片列表(可选)
+
+        cid  图片CID
+        path 图片路径
+    '''
+
+    # 参数判断
+    # match True:
+    #     case True if utils.vTrue(smtp, dict) == False:
+    #         logger.error('ERROR!! {} is not dictionary or none'.format('smtp'))
+    #         return False
+    #     case True if utils.vTrue(sender, dict) == False:
+    #         logger.error('ERROR!! {} is not dictionary or none'.format('sender'))
+    #         return False
+    #     case True if (utils.vTrue(recipients, str) == False) and (utils.vTrue(recipients, list) == False):
+    #         logger.error('ERROR!! {} is not list or none'.format('recipients'))
+    #         return False
+    #     case True if utils.vTrue(subject, str) == False:
+    #         logger.error('ERROR!! {} is not string or none'.format('subject'))
+    #         return False
+    #     case True if utils.vTrue(html_file, str) == False:
+    #         logger.error('ERROR!! {} is not string or none'.format('html_file'))
+    #         return False
+
+    logger.success('sendemail start')
+
+    try:
+
+        _message = MIMEMultipart('related')
+
+        with open(html_file, 'r') as _html_file:
+
+            _message.attach(MIMEText(_html_file.read(), 'html', 'utf-8'))
+
+            if utils.v_true(images, list):
+
+                for _image in images:
+
+                    try:
+
+                        if utils.check_file_type(_image.get('path', ''), 'file'):
+
+                            '''
+                            添加图片
+                            with open(image_path, 'rb') as image_file:
+                                mime_image = MIMEImage(image_file.read())
+                                # Define the image's ID as referenced above
+                                mime_image.add_header('Content-ID', '<CID>')
+                                message.attach(mime_image)
+                            '''
+
+                            with open(_image['path'], 'rb') as _image_file:
+                                _mime_image = MIMEImage(_image_file.read())
+                                _mime_image.add_header('Content-ID', '<{}>'.format(_image['cid']))
+                                _message.attach(_mime_image)
+
+                        else:
+
+                            next
+
+                    except Exception as e:
+                        logger.exception(e)
+                        next
+
+        # 发件人
+        _message['From'] = formataddr([sender.get('name'), sender.get('address')])
+
+        # 收件人
+        if utils.v_true(recipients, str):
+            _message['To'] = format_parse(recipients)
+        elif utils.v_true(recipients, list):
+            _message['To'] = ", ".join(list(map(format_parse, recipients)))
+        else:
+            logger.error('recipients error')
+            return False
+
+        # 主题
+        _message['Subject'] = subject
+
+        '''
+        发送邮件
+
+        SMTP.sendmail(from_addr, to_addrs, msg, mail_options=(), rcpt_options=())
+
+            to_addrs = sender_to + sender_cc
+            https://docs.python.org/3/library/smtplib.html#smtplib.SMTP.sendmail
+            https://gist.github.com/AO8/c5a6f747eeeca02351152ae8dc79b537
+        '''
+
+        if smtp.get('ssl', False) == True:
+
+            with smtplib.SMTP_SSL(smtp.get('server'), smtp.get('port')) as _smtp:
+                _smtp.login(sender.get('address'), sender.get('password'))
+                _smtp.sendmail(sender.get('address'), recipients, _message.as_string())
+
+        else:
+
+            with smtplib.SMTP(smtp.get('server'), smtp.get('port')) as _smtp:
+                _smtp.login(sender.get('address'), sender.get('password'))
+                _smtp.sendmail(sender.get('address'), recipients, _message.as_string())
+
+        logger.success('sendemail success')
+
+        return True
+
+    except Exception as e:
+        logger.error('sendemail error')
+        logger.exception(e)
+        return False