ezKit 1.12.0__py3-none-any.whl → 1.12.1__py3-none-any.whl

ezKit/bottle_extensions.py

@@ -1,4 +1,5 @@
 """Bottle Extensions"""
+
 from types import FunctionType
 from typing import Any
 
@@ -7,20 +8,23 @@ from . import bottle, utils
 
 def enable_cors(fn: FunctionType) -> Any | None:
     """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':
+        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:

ezKit/cipher.py

@@ -1,4 +1,5 @@
-"""Cipher"""
+"""Cipher Library"""
+
 # https://docs.python.org/3.10/library/hashlib.html
 # https://www.pycrypto.org/
 # https://stackoverflow.com/a/21928790
@@ -14,31 +15,31 @@ from loguru import logger
 class AESCipher:
     """AESCipher"""
 
-    def __init__(self, key: str = 'vB7DoRm9C2Kd', algorithm: str = 'sha256'):
+    def __init__(self, key: str = "vB7DoRm9C2Kd", algorithm: str = "sha256"):
 
         self.bs = AES.block_size
 
         # dir(hashlib)
         match True:
-            case True if algorithm == 'md5':
+            case True if algorithm == "md5":
                 self.key = hashlib.md5(key.encode()).digest()
-            case True if algorithm == 'sha1':
+            case True if algorithm == "sha1":
                 self.key = hashlib.sha1(key.encode()).digest()
-            case True if algorithm == 'sha224':
+            case True if algorithm == "sha224":
                 self.key = hashlib.sha224(key.encode()).digest()
-            case True if algorithm == 'sha256':
+            case True if algorithm == "sha256":
                 self.key = hashlib.sha256(key.encode()).digest()
-            case True if algorithm == 'sha384':
+            case True if algorithm == "sha384":
                 self.key = hashlib.sha384(key.encode()).digest()
-            case True if algorithm == 'sha512':
+            case True if algorithm == "sha512":
                 self.key = hashlib.sha512(key.encode()).digest()
-            case True if algorithm == 'sha3_224':
+            case True if algorithm == "sha3_224":
                 self.key = hashlib.sha3_224(key.encode()).digest()
-            case True if algorithm == 'sha3_256':
+            case True if algorithm == "sha3_256":
                 self.key = hashlib.sha3_256(key.encode()).digest()
-            case True if algorithm == 'sha3_384':
+            case True if algorithm == "sha3_384":
                 self.key = hashlib.sha3_384(key.encode()).digest()
-            case True if algorithm == 'sha3_512':
+            case True if algorithm == "sha3_512":
                 self.key = hashlib.sha3_512(key.encode()).digest()
             # case True if algorithm == 'shake_128':
             #     self.key = hashlib.shake_128(key.encode()).digest()
@@ -52,7 +53,7 @@ class AESCipher:
             raw = self._pad(raw)
             iv = Random.new().read(AES.block_size)
             cipher = AES.new(self.key, AES.MODE_CBC, iv)
-            return base64.b64encode(iv + cipher.encrypt(raw.encode())).decode('utf-8')
+            return base64.b64encode(iv + cipher.encrypt(raw.encode())).decode("utf-8")
         except Exception as e:
             logger.exception(e)
             return None
@@ -60,9 +61,11 @@ class AESCipher:
     def decrypt(self, enc: str) -> str | None:
         try:
             enc_bytes = base64.b64decode(enc)
-            iv = enc_bytes[:AES.block_size]
+            iv = enc_bytes[: AES.block_size]
             cipher = AES.new(self.key, AES.MODE_CBC, iv)
-            return self._unpad(cipher.decrypt(enc_bytes[AES.block_size:])).decode('utf-8')
+            return self._unpad(cipher.decrypt(enc_bytes[AES.block_size :])).decode(
+                "utf-8"
+            )
         except Exception as e:
             logger.exception(e)
             return None
@@ -72,4 +75,4 @@ class AESCipher:
 
     @staticmethod
     def _unpad(s: bytes) -> bytes:
-        return s[:-ord(s[len(s) - 1:])]
+        return s[: -ord(s[len(s) - 1 :])]

ezKit/database.py

@@ -1,4 +1,5 @@
-"""Database"""
+"""Database Library"""
+
 # Column, Table, MetaData API
 #     https://docs.sqlalchemy.org/en/14/core/metadata.html#column-table-metadata-api
 # CursorResult
@@ -17,10 +18,10 @@ from sqlalchemy.orm import DeclarativeBase
 from . import utils
 
 
-class Database():
+class Database:
     """Database"""
 
-    engine = create_engine('sqlite://')
+    engine = create_engine("sqlite://")
 
     def __init__(self, target: str | None = None, **options):
         """Initiation"""
@@ -85,10 +86,10 @@ class Database():
             except Exception as e:
                 logger.exception(e)
             idx.create(bind=self.engine)
-            logger.success(f'{info} [success]')
+            logger.success(f"{info} [success]")
             return True
         except Exception as e:
-            logger.error(f'{info} [failed]')
+            logger.error(f"{info} [failed]")
             logger.error(e)
             return False
 
@@ -227,10 +228,10 @@ class Database():
         self,
         sql: str | None = None,
         read_sql_file: dict | None = None,
-        save_to_csv: dict | None = None
+        save_to_csv: dict | None = None,
     ) -> CursorResult[Any] | bool | None:
 
-        info: str = 'Database connect execute'
+        info: str = "Database connect execute"
 
         logger.info(f"{info} ......")
 
@@ -245,12 +246,14 @@ class Database():
                 read_sql_file_kwargs: dict = {
                     "mode": "r",
                     "encoding": "utf-8",
-                    **read_sql_file
+                    **read_sql_file,
                 }
                 with open(encoding="utf-8", **read_sql_file_kwargs) as _file:
                     sql_statement = _file.read()
             else:
-                if not (isinstance(sql, str) and utils.check_arguments([(sql, str, "sql")])):
+                if not (
+                    isinstance(sql, str) and utils.check_arguments([(sql, str, "sql")])
+                ):
                     return None
                 sql_statement = sql
         except Exception as e:
@@ -274,11 +277,13 @@ class Database():
                     logger.success(f"{info} [success]")
 
                     # 返回查询结果
-                    if isinstance(save_to_csv, dict) and utils.isTrue(save_to_csv, dict):
+                    if isinstance(save_to_csv, dict) and utils.isTrue(
+                        save_to_csv, dict
+                    ):
                         save_to_csv_kwargs: dict = {
                             "mode": "w",
                             "encoding": "utf-8",
-                            **save_to_csv
+                            **save_to_csv,
                         }
                         with open(encoding="utf-8", **save_to_csv_kwargs) as _file:
                             return self._result_save(_file, result)
@@ -294,10 +299,7 @@ class Database():
     # ----------------------------------------------------------------------------------------------
 
     def read_with_pandas(
-        self,
-        method: str = "read_sql",
-        result_type: str = "df",
-        **kwargs
+        self, method: str = "read_sql", result_type: str = "df", **kwargs
     ) -> pd.DataFrame | list | dict:
         """读取数据"""
 
@@ -322,7 +324,7 @@ class Database():
             logger.info(f"{info} ......")
 
             # 从 kwargs 中删除 con 键
-            kwargs.pop('con', None)
+            kwargs.pop("con", None)
 
             match method:
                 case "read_sql":
@@ -343,12 +345,12 @@ class Database():
 
             match result_type:
                 case "json":
-                    return json.loads(data.to_json(orient='records'))
+                    return json.loads(data.to_json(orient="records"))
                 case "dict":
                     return data.to_dict()
                 case "list":
                     # https://stackoverflow.com/a/26716774
-                    return data.to_dict('list')
+                    return data.to_dict("list")
                 case _:
                     return data
 

ezKit/dockerhub.py

@@ -1,9 +1,12 @@
-"""Docker Hub"""
+"""Docker Hub Library"""
+
 import requests
 from loguru import logger
 
 
-def get_latest_tags(url: str, limit: int = 20, proxies: dict | None = None) -> list | None:
+def get_latest_tags(
+    url: str, limit: int = 20, proxies: dict | None = None
+) -> list | None:
 
     info: str = "获取最新标签"
 
@@ -20,7 +23,9 @@ def get_latest_tags(url: str, limit: int = 20, proxies: dict | None = None) -> l
         # }
 
         # 请求接口
-        response = requests.get(url, params={"page": 1, "page_size": limit}, proxies=proxies, timeout=10)
+        response = requests.get(
+            url, params={"page": 1, "page_size": limit}, proxies=proxies, timeout=10
+        )
 
         # 检查请求状态码
         if response.status_code != 200:
@@ -47,6 +52,7 @@ def get_latest_tags(url: str, limit: int = 20, proxies: dict | None = None) -> l
         logger.exception(e)
         return None
 
+
 # def get_all_tags():
 #     url = "https://hub.docker.com/v2/repositories/library/postgres/tags"
 #     tags = []

ezKit/http.py

@@ -1,4 +1,5 @@
-"""HTTP"""
+"""HTTP Library"""
+
 import json
 from typing import Any
 
@@ -13,7 +14,7 @@ def download(
     file: dict,
     chunks: bool = False,
     iter_content: dict | None = None,
-    info: str | None = None
+    info: str | None = None,
 ) -> bool:
     """下载文件"""
 
@@ -38,7 +39,7 @@ def download(
 
     try:
 
-        logger.info(f'{info_prefix} ......')
+        logger.info(f"{info_prefix} ......")
 
         response = requests.request(**request_arguments)
 
@@ -51,13 +52,13 @@ def download(
             else:
                 _file.write(response.content)
 
-        logger.success(f'{info_prefix} [success]')
+        logger.success(f"{info_prefix} [success]")
 
         return True
 
     except Exception as e:
 
-        logger.error(f'{info_prefix} [failed]')
+        logger.error(f"{info_prefix} [failed]")
         logger.exception(e)
         return False
 
@@ -65,7 +66,9 @@ def download(
 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)
+        return json.dumps(
+            data, default=str, ensure_ascii=False, sort_keys=True, **kwargs
+        )
     except Exception as e:
         logger.exception(e)
         return None

ezKit/mongo.py

@@ -1,4 +1,5 @@
-"""MongoDB"""
+"""MongoDB Library"""
+
 from loguru import logger
 from pymongo import MongoClient
 from pymongo.collection import Collection
@@ -6,7 +7,7 @@ from pymongo.collection import Collection
 from . import utils
 
 
-class Mongo():
+class Mongo:
     """MongoDB"""
 
     client = MongoClient()

ezKit/qywx.py

@@ -1,4 +1,5 @@
-"""企业微信"""
+"""腾讯企业微信"""
+
 #
 # 企业微信开发者中心
 #     https://developer.work.weixin.qq.com/
@@ -60,7 +61,13 @@ class QYWX:
     # Token: https://developer.work.weixin.qq.com/document/path/90665#access-token
     access_token: str = ""
 
-    def __init__(self, work_id: str, agent_id: str, agent_secret: str, api_prefix: str = "https://qyapi.weixin.qq.com"):
+    def __init__(
+        self,
+        work_id: str,
+        agent_id: str,
+        agent_secret: str,
+        api_prefix: str = "https://qyapi.weixin.qq.com",
+    ):
         """Initiation"""
         self.api_prefix = api_prefix
         self.work_id = work_id
@@ -79,7 +86,10 @@ class QYWX:
 
             logger.info(f"{info} ......")
 
-            response = requests.get(f"{self.api_prefix}/cgi-bin/gettoken?corpid={self.work_id}&corpsecret={self.agent_secret}", timeout=10)
+            response = requests.get(
+                f"{self.api_prefix}/cgi-bin/gettoken?corpid={self.work_id}&corpsecret={self.agent_secret}",
+                timeout=10,
+            )
 
             if response.status_code != 200:
                 logger.error(f"{info} [状态码错误]")
@@ -170,9 +180,13 @@ class QYWX:
             if not utils.isTrue(self.access_token, str):
                 self.get_access_token()
 
-            json_string = json.dumps({'mobile': mobile})
+            json_string = json.dumps({"mobile": mobile})
 
-            response = requests.post(f"{self.api_prefix}/cgi-bin/user/getuserid?access_token={self.access_token}", data=json_string, timeout=10)
+            response = requests.post(
+                f"{self.api_prefix}/cgi-bin/user/getuserid?access_token={self.access_token}",
+                data=json_string,
+                timeout=10,
+            )
 
             if response.status_code != 200:
                 logger.error(f"{info} [接口请求错误]")
@@ -180,7 +194,7 @@ class QYWX:
 
             response_data: dict = response.json()
 
-            if response_data.get('errcode') == 42001:
+            if response_data.get("errcode") == 42001:
                 self.get_access_token()
                 time.sleep(1)
                 self.get_user_id_by_mobile(mobile)
@@ -222,7 +236,9 @@ class QYWX:
 
         info: str = "发送消息"
 
-        if not utils.check_arguments([(mobile, (str, list), "mobile"), (message, str, "message")]):
+        if not utils.check_arguments(
+            [(mobile, (str, list), "mobile"), (message, str, "message")]
+        ):
             logger.error(f"{info} [失败]")
             return False
 
@@ -251,28 +267,39 @@ class QYWX:
 
                 user_object = self.get_user_id_by_mobile(user)
 
-                if not (isinstance(user_object, dict) and utils.isTrue(user_object, dict)):
+                if not (
+                    isinstance(user_object, dict) and utils.isTrue(user_object, dict)
+                ):
                     logger.error(f"{info} [获取用户ID错误: {user}]")
                     continue
 
-                if user_object.get("errcode", -1) != 0 or user_object.get("errmsg", "") != "ok":
-                    logger.error(f"{user_object.get('errcode')}: {user_object.get('errmsg')}")
+                if (
+                    user_object.get("errcode", -1) != 0
+                    or user_object.get("errmsg", "") != "ok"
+                ):
+                    logger.error(
+                        f"{user_object.get('errcode')}: {user_object.get('errmsg')}"
+                    )
                     continue
 
                 json_dict = {
-                    'touser': user_object.get('userid'),
-                    'msgtype': 'text',
-                    'agentid': self.agent_id,
-                    'text': {'content': message},
-                    'safe': 0,
-                    'enable_id_trans': 0,
-                    'enable_duplicate_check': 0,
-                    'duplicate_check_interval': 1800
+                    "touser": user_object.get("userid"),
+                    "msgtype": "text",
+                    "agentid": self.agent_id,
+                    "text": {"content": message},
+                    "safe": 0,
+                    "enable_id_trans": 0,
+                    "enable_duplicate_check": 0,
+                    "duplicate_check_interval": 1800,
                 }
 
                 json_string = json.dumps(json_dict)
 
-                response = requests.post(f"{self.api_prefix}/cgi-bin/message/send?access_token={self.access_token}", data=json_string, timeout=10)
+                response = requests.post(
+                    f"{self.api_prefix}/cgi-bin/message/send?access_token={self.access_token}",
+                    data=json_string,
+                    timeout=10,
+                )
 
                 if response.status_code != 200:
                     logger.error(f"{info} [发送消息失败: {user}]")
@@ -280,7 +307,7 @@ class QYWX:
 
                 response_data: dict = response.json()
 
-                if response_data.get('errcode') == 42001:
+                if response_data.get("errcode") == 42001:
                     self.get_access_token()
                     time.sleep(1)
                     self.send_message_by_mobile(mobile, message)

ezKit/redis.py

@@ -1,4 +1,5 @@
-"""Redis"""
+"""Redis Library"""
+
 import redis as RedisClient
 from loguru import logger
 

ezKit/sendemail.py

@@ -1,4 +1,5 @@
-"""发送邮件"""
+"""Send eMail Library"""
+
 # https://stackoverflow.com/questions/882712/sending-html-email-using-python
 import smtplib
 from email.header import Header
@@ -15,33 +16,40 @@ from . import utils
 
 class TypedSMTP(TypedDict):
     """smtp type"""
+
     server: str
     port: int
     tls: bool
 
+
 class TypedSender(TypedDict):
     """sender type"""
+
     name: str
     address: str
     password: str
 
+
 class TypedBody(TypedDict, total=False):
     """body type"""
+
     content: str
     type: str | None  # "plain", "html", or "file"
 
+
 def format_parse(s):
     """格式化邮件地址"""
     _name, _addr = parseaddr(s)
     return formataddr((Header(_name, "utf-8").encode(), _addr))
 
+
 def sendemail(
     smtp: TypedSMTP,
     sender: TypedSender,
     recipients: str | list,
     subject: str,
     body: TypedBody,
-    images: None | list = None
+    images: None | list = None,
 ) -> bool:
     """发送邮件"""
 
@@ -233,10 +241,10 @@ def sendemail(
     except Exception as e:
 
         # 忽略腾讯邮箱返回的异常
-        if e.args == (-1, b'\x00\x00\x00'):
+        if e.args == (-1, b"\x00\x00\x00"):
             # pass
             return True
 
-        logger.error('sendemail error')
+        logger.error("sendemail error")
         logger.exception(e)
         return False

ezKit/token.py

@@ -1,4 +1,5 @@
-"""Token"""
+"""Token Library"""
+
 import json
 from typing import Any
 
@@ -7,7 +8,9 @@ from loguru import logger
 from . import cipher, utils
 
 
-def generate_token(key: str = 'Fc0zXCmGKd7tPu6W', timeout: int = 3600, data: Any = None) -> (str | None):
+def generate_token(
+    key: str = "Fc0zXCmGKd7tPu6W", timeout: int = 3600, data: Any = None
+) -> str | None:
     try:
         now = utils.datetime_now()
 
@@ -20,14 +23,11 @@ def generate_token(key: str = 'Fc0zXCmGKd7tPu6W', timeout: int = 3600, data: Any
             return None
 
         source = json.dumps(
-            obj={
-                "datetime": utils.datetime_to_string(offset),
-                "data": data
-            },
-            default=str
+            obj={"datetime": utils.datetime_to_string(offset), "data": data},
+            default=str,
         )
 
-        aes_cipher = cipher.AESCipher(key=key, algorithm='sha256')
+        aes_cipher = cipher.AESCipher(key=key, algorithm="sha256")
 
         return aes_cipher.encrypt(source)
 
@@ -36,12 +36,12 @@ def generate_token(key: str = 'Fc0zXCmGKd7tPu6W', timeout: int = 3600, data: Any
         return None
 
 
-def parsing_token(token_string: str, key: str = 'Fc0zXCmGKd7tPu6W') -> (dict | None):
+def parsing_token(token_string: str, key: str = "Fc0zXCmGKd7tPu6W") -> dict | None:
     try:
         if not utils.isTrue(token_string, str):
             return None
 
-        aes_cipher = cipher.AESCipher(key=key, algorithm='sha256')
+        aes_cipher = cipher.AESCipher(key=key, algorithm="sha256")
 
         target = aes_cipher.decrypt(token_string)
 
@@ -50,7 +50,7 @@ def parsing_token(token_string: str, key: str = 'Fc0zXCmGKd7tPu6W') -> (dict | N
 
         source: dict = json.loads(target)
 
-        source['datetime'] = utils.datetime_string_to_datetime(source['datetime'])
+        source["datetime"] = utils.datetime_string_to_datetime(source["datetime"])
 
         return source
 
@@ -59,7 +59,7 @@ def parsing_token(token_string: str, key: str = 'Fc0zXCmGKd7tPu6W') -> (dict | N
         return None
 
 
-def certify_token(token_string: str, key: str = 'Fc0zXCmGKd7tPu6W') -> bool:
+def certify_token(token_string: str, key: str = "Fc0zXCmGKd7tPu6W") -> bool:
     try:
 
         result = parsing_token(token_string, key)
@@ -67,7 +67,7 @@ def certify_token(token_string: str, key: str = 'Fc0zXCmGKd7tPu6W') -> bool:
         if result is None:
             return False
 
-        if result.get('datetime') < utils.datetime_now():  # type: ignore
+        if result.get("datetime") < utils.datetime_now():  # type: ignore
             return False
 
         return True