ezKit 1.7.8__tar.gz → 1.8.0__tar.gz

{ezkit-1.7.8/ezKit.egg-info → ezkit-1.8.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ezKit
-Version: 1.7.8
+Version: 1.8.0
 Summary: Easy Kit
 Author: septvean
 Author-email: septvean@gmail.com

ezkit-1.8.0/README.md

@@ -0,0 +1 @@
+# Python Easy Kit

{ezkit-1.7.8 → ezkit-1.8.0}/ezKit/bottle.py

@@ -17,7 +17,7 @@ from __future__ import print_function
 import sys
 
 __author__ = 'Marcel Hellkamp'
-__version__ = '0.13.1'
+__version__ = '0.13.2'
 __license__ = 'MIT'
 
 ###############################################################################
@@ -185,6 +185,7 @@ def depr(major, minor, cause, fix, stacklevel=3):
     if DEBUG == 'strict':
         raise DeprecationWarning(text)
     warnings.warn(text, DeprecationWarning, stacklevel=stacklevel)
+    return DeprecationWarning(text)
 
 
 def makelist(data):  # This is just too handy
@@ -4671,5 +4672,9 @@ def _main(argv):  # pragma: no coverage
         config=config)
 
 
-if __name__ == '__main__':  # pragma: no coverage
+def main():
     _main(sys.argv)
+
+
+if __name__ == '__main__':  # pragma: no coverage
+    main()

ezkit-1.8.0/ezKit/bottle_extensions.py

@@ -0,0 +1,32 @@
+"""Bottle Extensions"""
+from typing import Callable
+
+from . import bottle, utils
+
+
+def enable_cors(fn: Callable) -> Callable:
+    """Bottle CORS"""
+    # 参考文档:
+    # - https://stackoverflow.com/a/17262900
+    # - https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Headers
+    # - https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Methods
+    # - https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin
+    def cors(*args, **kwargs):
+        bottle.response.headers['Access-Control-Allow-Headers'] = '*'
+        bottle.response.headers['Access-Control-Allow-Methods'] = '*'
+        bottle.response.headers['Access-Control-Allow-Origin'] = '*'
+        if bottle.request.method != 'OPTIONS':
+            return fn(*args, **kwargs)
+        return None
+    return cors
+
+def request_json() -> bottle.DictProperty | None:
+    """Bottle Request JSON"""
+    try:
+        data = bottle.request.json
+        if utils.v_true(data, dict):
+            return data
+        return None
+    except Exception as e:
+        print(e)
+        return None

ezkit-1.8.0/ezKit/database.py

@@ -0,0 +1,204 @@
+"""
+Column, Table, MetaData API
+    https://docs.sqlalchemy.org/en/14/core/metadata.html#column-table-metadata-api
+CursorResult
+    https://docs.sqlalchemy.org/en/20/core/connections.html#sqlalchemy.engine.CursorResult
+PostgreSQL 14 Data Types
+    https://www.postgresql.org/docs/14/datatype.html
+"""
+import csv
+from typing import Any
+
+from loguru import logger
+from sqlalchemy import CursorResult, Index, create_engine, text
+
+from . import utils
+
+
+class Database():
+    """Database"""
+
+    engine = create_engine('sqlite://')
+
+    def __init__(self, engine_url, **engine_options):
+        """Initiation"""
+        if engine_url is not None and utils.v_true(engine_url, str):
+            if utils.v_true(engine_options, dict):
+                self.engine = create_engine(engine_url, **engine_options)
+            else:
+                self.engine = create_engine(engine_url)
+        else:
+            pass
+
+    def initializer(self):
+        """ensure the parent proc's database connections are not touched in the new connection pool"""
+        self.engine.dispose(close=False)
+
+    def connect_test(self) -> bool:
+        info = "Database connect test"
+        try:
+            logger.info(f"{info} ......")
+            self.engine.connect()
+            logger.success(f"{info} [success]")
+            return True
+        except Exception as e:
+            logger.error(f"{info} [failure]")
+            logger.exception(e)
+            return False
+
+    def metadata_init(self, base, **kwargs) -> bool:
+        # https://stackoverflow.com/questions/19175311/how-to-create-only-one-table-with-sqlalchemy
+        info = "Database init table"
+        try:
+            logger.info(f"{info} ......")
+            base.metadata.drop_all(self.engine, **kwargs)
+            base.metadata.create_all(self.engine, **kwargs)
+            logger.success(f"{info} [success]")
+            return True
+        except Exception as e:
+            logger.error(f"{info} [failure]")
+            logger.exception(e)
+            return False
+
+    def create_index(self, index_name, table_field) -> bool:
+        # 创建索引
+        #   https://stackoverflow.com/a/41254430
+        # 示例:
+        #   index_name: a_share_list_code_idx1
+        #   table_field: Table_a_share_list.code
+        info = "Database create index"
+        try:
+            logger.info(f"{info} ......")
+            idx = Index(index_name, table_field)
+            try:
+                idx.drop(bind=self.engine)
+            except Exception as e:
+                logger.exception(e)
+            idx.create(bind=self.engine)
+            logger.success(f'{info} [success]')
+            return True
+        except Exception as e:
+            logger.error(f'{info} [failure]')
+            logger.error(e)
+            return False
+
+    # 私有函数, 保存 execute 的结果到 CSV 文件
+    def _result_save(self, file, data) -> bool:
+        try:
+            outcsv = csv.writer(file)
+            outcsv.writerow(data.keys())
+            outcsv.writerows(data)
+            return True
+        except Exception as e:
+            logger.exception(e)
+            return False
+
+    def execute(
+        self,
+        sql: str | None = None,
+        sql_file: str | None = None,
+        sql_file_kwargs: dict | None = None,
+        csv_file: str | None = None,
+        csv_file_kwargs: dict | None = None
+    ) -> CursorResult[Any] | bool:
+        """
+        echo 是否打印日志
+        某些情况下只需要结果, 不需要日志, 将 echo 设置为 False 即可
+        """
+
+        # info_prefix = '[Execute SQL]'
+
+        # ------------------------------------------------------------
+
+        # 提取 SQL
+        # 如果 sql 和 sql_file 同时存在, 优先执行 sql
+        sql_object = None
+        info: str = "Extract SQL"
+        try:
+
+            logger.info(f"{info} ......")
+
+            if utils.v_true(sql, str):
+
+                sql_object = sql
+
+            elif sql_file is not None and utils.v_true(sql_file, str):
+
+                # 判断文件是否存在
+                if isinstance(sql_file, str) and utils.check_file_type(sql_file, "file") is False:
+
+                    logger.error(f"No such file: {sql_file}")
+                    return False
+
+                if isinstance(sql_file, str) and utils.v_true(sql_file, str):
+
+                    # 读取文件内容
+                    if sql_file_kwargs is not None and utils.v_true(sql_file_kwargs, dict):
+                        with open(sql_file, "r", encoding="utf-8", **sql_file_kwargs) as _file:
+                            sql_object = _file.read()
+                    else:
+                        with open(sql_file, "r", encoding="utf-8") as _file:
+                            sql_object = _file.read()
+
+            else:
+
+                logger.error("SQL or SQL file error")
+                logger.error(f"{info} [failure]")
+                return False
+
+            logger.success(f'{info} [success]')
+
+        except Exception as e:
+
+            logger.error(f"{info} [failure]")
+            logger.exception(e)
+            return False
+
+        # ------------------------------------------------------------
+
+        # 执行 SQL
+        info: str = "Execute SQL"
+        try:
+
+            logger.info(f"{info} ......")
+
+            with self.engine.connect() as connect:
+
+                # 执行SQL
+                if sql_object is None:
+                    return False
+
+                result = connect.execute(text(sql_object))
+
+                if csv_file is None:
+                    # 如果 csv_file 没有定义, 则直接返回结果
+                    logger.success(f'{info} [success]')
+                    return result
+
+                # 如果 csv_file 有定义, 则保存结果到 csv_file
+                info_of_save = f"Save result to file: {csv_file}"
+                logger.info(f"{info_of_save} .......")
+
+                # 保存结果
+                if isinstance(csv_file_kwargs, dict) and utils.v_true(csv_file_kwargs, dict):
+                    with open(csv_file, "w", encoding="utf-8", **csv_file_kwargs) as _file:
+                        result_of_save = self._result_save(_file, result)
+                else:
+                    with open(csv_file, "w", encoding="utf-8") as _file:
+                        result_of_save = self._result_save(_file, result)
+
+                # 检查保存结果
+                if result_of_save is True:
+                    logger.success(f'{info_of_save} [success]')
+                    logger.success(f'{info} [success]')
+                    return True
+
+                logger.error(f"{info_of_save} [failure]")
+                logger.error(f"{info} [failure]")
+                return False
+
+        except Exception as e:
+
+            logger.error(f'{info} [failure]')
+            logger.exception(e)
+            return False

ezkit-1.8.0/ezKit/http.py

@@ -0,0 +1,70 @@
+import json
+from typing import Any
+
+import requests
+from loguru import logger
+
+from . import utils
+
+
+def download(
+    request: dict,
+    file: dict,
+    chunks: bool = False,
+    iter_content: dict | None = None,
+    info: str | None = None
+) -> bool:
+    """下载文件"""
+
+    if utils.v_true(request, dict):
+        request_arguments = {"method": "GET", "stream": True, **request}
+    else:
+        return False
+
+    if utils.v_true(file, dict):
+        file_arguments = {"mode": "wb", **file}
+    else:
+        return False
+
+    if iter_content is not None and utils.v_true(iter_content, dict):
+        iter_content_arguments = {"chunk_size": 1024, **iter_content}
+    else:
+        iter_content_arguments = {"chunk_size": 1024}
+
+    info_prefix: str = "Download"
+    if utils.v_true(info, str):
+        info_prefix = f"Download {info}"
+
+    try:
+
+        logger.info(f'{info_prefix} ......')
+
+        response = requests.request(**request_arguments)
+
+        # # pylint: disable=W1514
+        with open(**file_arguments) as _file:  # type: ignore
+
+            if utils.v_true(chunks, bool):
+                for _chunk in response.iter_content(**iter_content_arguments):  # type: ignore
+                    _file.write(_chunk)
+            else:
+                _file.write(response.content)
+
+        logger.success(f'{info_prefix} [success]')
+
+        return True
+
+    except Exception as e:
+
+        logger.error(f'{info_prefix} [failure]')
+        logger.exception(e)
+        return False
+
+
+def response_json(data: Any = None, **kwargs) -> str | None:
+    """解决字符编码问题: ensure_ascii=False"""
+    try:
+        return json.dumps(data, default=str, ensure_ascii=False, sort_keys=True, **kwargs)
+    except Exception as e:
+        logger.exception(e)
+        return None

{ezkit-1.7.8 → ezkit-1.8.0}/ezKit/mongo.py

@@ -28,7 +28,7 @@ class Mongo():
             logger.success(f"{info} [success]")
             return True
         except Exception as e:
-            logger.error(f"{info} [failed]")
+            logger.error(f"{info} [failure]")
             logger.exception(e)
             return False
 
@@ -56,12 +56,12 @@ class Mongo():
                 # 插入多条数据
                 result = db_collection.insert_many(data)
             else:
-                logger.error(f"{info} [failed]")
+                logger.error(f"{info} [failure]")
                 logger.error("Data type error")
                 return False
             logger.success(f"{info} [success]")
             return result
         except Exception as e:
-            logger.error(f"{info} [failed]")
+            logger.error(f"{info} [failure]")
             logger.exception(e)
             return False

{ezkit-1.7.8 → ezkit-1.8.0}/ezKit/redis.py

@@ -20,9 +20,10 @@ class Redis:
         """Initiation"""
         if isinstance(arguments, str) and utils.v_true(arguments, str):
             self.redis = RedisClient.from_url(arguments)
-
-        if isinstance(arguments, dict) and utils.v_true(arguments, dict):
+        elif isinstance(arguments, dict) and utils.v_true(arguments, dict):
             self.redis = RedisClient.Redis(**arguments)
+        else:
+            pass
 
     def connect_test(self) -> bool:
         info = "Redis connect test"
@@ -32,7 +33,7 @@ class Redis:
             logger.success(f"{info} [success]")
             return True
         except Exception as e:
-            logger.error(f"{info} [failed]")
+            logger.error(f"{info} [failure]")
             logger.exception(e)
             return False
 
@@ -48,6 +49,6 @@ class Redis:
             logger.success(f"{info} [success]")
             return True
         except Exception as e:
-            logger.error(f"{info} [failed]")
+            logger.error(f"{info} [failure]")
             logger.exception(e)
             return False

{ezkit-1.7.8 → ezkit-1.8.0}/ezKit/sendemail.py

@@ -1,12 +1,5 @@
 """发送邮件"""
 # https://stackoverflow.com/questions/882712/sending-html-email-using-python
-# pylint: disable=E0611
-# pylint: disable=R0911
-# pylint: disable=R0912
-# pylint: disable=R0913
-# pylint: disable=R0914
-# pylint: disable=R0915
-# pylint: disable=R1710
 import smtplib
 from email.header import Header
 from email.mime.image import MIMEImage

{ezkit-1.7.8 → ezkit-1.8.0}/ezKit/utils.py

@@ -1468,8 +1468,8 @@ def create_empty_file(
         # 创建一个空文件
         if v_true(debug, bool):
             logger.info(f"file: {file}")
-        # pylint: disable=R1732,disable=W1514
-        open(file, 'w').close()
+        # pylint: disable=R1732
+        open(file, "w", encoding="utf-8").close()
         # 返回文件路径
         return file
     except Exception as e:

{ezkit-1.7.8 → ezkit-1.8.0/ezKit.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ezKit
-Version: 1.7.8
+Version: 1.8.0
 Summary: Easy Kit
 Author: septvean
 Author-email: septvean@gmail.com

{ezkit-1.7.8 → ezkit-1.8.0}/ezKit.egg-info/SOURCES.txt

@@ -7,18 +7,13 @@ ezKit/bottle.py
 ezKit/bottle_extensions.py
 ezKit/cipher.py
 ezKit/database.py
-ezKit/files.py
 ezKit/http.py
 ezKit/mongo.py
-ezKit/plots.py
-ezKit/qywx.py
 ezKit/redis.py
-ezKit/reports.py
 ezKit/sendemail.py
 ezKit/token.py
 ezKit/utils.py
 ezKit/xftp.py
-ezKit/zabbix.py
 ezKit.egg-info/PKG-INFO
 ezKit.egg-info/SOURCES.txt
 ezKit.egg-info/dependency_links.txt

{ezkit-1.7.8 → ezkit-1.8.0}/setup.py

@@ -3,7 +3,7 @@ from setuptools import find_packages, setup
 
 setup(
     name='ezKit',
-    version='1.7.8',
+    version='1.8.0',
     author='septvean',
     author_email='septvean@gmail.com',
     description='Easy Kit',

ezkit-1.7.8/README.md

@@ -1,60 +0,0 @@
-# Python Easy Kit
-
-## 代码规范
-
-- [PEP 8 – Style Guide for Python Code](https://peps.python.org/pep-0008/)
-- [PEP8 翻译](https://www.jianshu.com/p/78d76f85bd82)
-- [PEP 8 -- Python 代码风格指南](https://github.com/kernellmd/Knowledge/blob/master/Translation/PEP%208%20%E4%B8%AD%E6%96%87%E7%BF%BB%E8%AF%91.md)
-
-注释长度: 100
-
-版本号说明: [PEP 440 – Version Identification and Dependency Specification](https://peps.python.org/pep-0440/)
-
-配置文件格式: TOML
-
-----------------------------------------------------------------------------------------------------
-
-## 函数
-
-- 明确 参数 的类型
-    - 尽量避免使用 *args 和 **kwargs
-    - 必须判断参数: 先判断参数是否为 None, 然后再判断参数类型
-- 必须有返回值, 且明确返回值的类型(默认返回 bool 类型)
-    - 函数执行成功返回 True
-    - 执行执行失败返回 False
-- 添加一个 debug 参数, 用于调试
-    - 如果 debug 为 True, 则输出相关信息, 否则一律不输出任何信息
-- 必须有说明
-- 必须用 `try ... except ...` 包裹
-- 使用 loguru 输出信息 (不使用 print), 方便定位
-
-```py
-from loguru import logger
-def func(debug: bool = False) -> bool:
-    try:
-        if debug is True:
-            logger.info("info ...")
-        # ...
-        return True
-    except Exception as e:
-        logger.exception(e)
-        return False
-```
-
-----------------------------------------------------------------------------------------------------
-
-相关命令
-
-```sh
-# 打包
-bash -x build.sh
-
-# 上传
-bash -x upload.sh
-
-# 在线安装
-pip install -U ezKit
-
-# 离线安装
-pip install -U ezKit-1.7.0.tar.gz
-```

ezkit-1.7.8/ezKit/bottle_extensions.py

@@ -1,36 +0,0 @@
-from typing import Callable
-
-from . import bottle, utils
-
-
-def enable_cors(fn: Callable) -> Callable:
-    """
-    Bottle CORS
-    """
-    """
-    参考文档:
-    - https://stackoverflow.com/a/17262900
-    - https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Headers
-    - https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Methods
-    - https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin
-    """
-    def cors(*args, **kwargs):
-        bottle.response.headers['Access-Control-Allow-Headers'] = '*'
-        bottle.response.headers['Access-Control-Allow-Methods'] = '*'
-        bottle.response.headers['Access-Control-Allow-Origin'] = '*'
-        if bottle.request.method != 'OPTIONS':
-            return fn(*args, **kwargs)
-    return cors
-
-def request_json() -> dict | None:
-    """
-    Bottle Request JSON
-    """
-    try:
-        data: dict = bottle.request.json
-        if utils.v_true(data, dict):
-            return data
-        else:
-            return None
-    except:
-        return None