ezKit 1.7.6__tar.gz → 1.7.8__tar.gz

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

@@ -1,8 +1,9 @@
 Metadata-Version: 2.1
 Name: ezKit
-Version: 1.7.6
+Version: 1.7.8
 Summary: Easy Kit
 Author: septvean
 Author-email: septvean@gmail.com
 Requires-Python: >=3.11
 License-File: LICENSE
+Requires-Dist: loguru>=0.7.0

ezkit-1.7.8/README.md

@@ -0,0 +1,60 @@
+# 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.6 → ezkit-1.7.8}/ezKit/cipher.py

@@ -1,9 +1,9 @@
-'''
+"""
 https://docs.python.org/3.10/library/hashlib.html
 https://www.pycrypto.org/
 https://stackoverflow.com/a/21928790
 pip install pycryptodome
-'''
+"""
 import base64
 import hashlib
 
@@ -12,7 +12,8 @@ from Crypto.Cipher import AES
 from loguru import logger
 
 
-class AESCipher(object):
+class AESCipher:
+    """AESCipher"""
 
     def __init__(self, key: str = 'vB7DoRm9C2Kd', algorithm: str = 'sha256'):
 
@@ -40,10 +41,10 @@ class AESCipher(object):
                 self.key = hashlib.sha3_384(key.encode()).digest()
             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()
-            case True if algorithm == 'shake_256':
-                self.key = hashlib.shake_256(key.encode()).digest()
+            # case True if algorithm == 'shake_128':
+            #     self.key = hashlib.shake_128(key.encode()).digest()
+            # case True if algorithm == 'shake_256':
+            #     self.key = hashlib.shake_256(key.encode()).digest()
             case _:
                 self.key = hashlib.sha256(key.encode()).digest()
 
@@ -59,10 +60,10 @@ class AESCipher(object):
 
     def decrypt(self, enc: str) -> str | None:
         try:
-            enc = base64.b64decode(enc)
-            iv = enc[:AES.block_size]
+            enc_bytes = base64.b64decode(enc)
+            iv = enc_bytes[:AES.block_size]
             cipher = AES.new(self.key, AES.MODE_CBC, iv)
-            return self._unpad(cipher.decrypt(enc[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

{ezkit-1.7.6 → ezkit-1.7.8}/ezKit/database.py

@@ -14,13 +14,14 @@ from sqlalchemy import Index, create_engine, text
 from . import utils
 
 
-class Database(object):
+class Database():
+    """Database"""
 
     engine = create_engine('sqlite://')
 
-    def __init__(self, engine_url=None, engine_options=None):
+    def __init__(self, engine_url, **engine_options):
         '''Initiation'''
-        if engine_url != None:
+        if engine_url is not None:
             if utils.v_true(engine_options, dict):
                 self.engine = create_engine(engine_url, **engine_options)
             else:
@@ -68,8 +69,8 @@ class Database(object):
             idx = Index(index_name, table_field)
             try:
                 idx.drop(bind=self.engine)
-            except:
-                pass
+            except Exception as e:
+                logger.exception(e)
             idx.create(bind=self.engine)
             logger.success(f'{info}[成功]')
             return True
@@ -86,7 +87,8 @@ class Database(object):
             outcsv.writerows(data)
             return True
         except Exception as e:
-            logger.exception(e) if echo == True else next
+            if echo is True:
+                logger.exception(e)
             return False
 
     def execute(self, sql=None, sql_file=None, sql_file_kwargs=None, csv_file=None, csv_file_kwargs=None, echo=True):
@@ -104,12 +106,13 @@ class Database(object):
         sql_object = None
         info = f'{info_prefix}提取SQL'
         try:
-            logger.info(f'{info}......') if echo == True else next
+            if echo is True:
+                logger.info(f'{info}......')
             if utils.v_true(sql, str):
                 sql_object = sql
             elif utils.v_true(sql_file, str):
                 # 判断文件是否存在
-                if utils.check_file_type(sql_file, 'file') == False:
+                if utils.check_file_type(sql_file, 'file') is False:
                     logger.error(f'文件不存在: {sql_file}') if echo == True else next
                     return False
                 # 读取文件内容

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

@@ -1,6 +1,7 @@
 """MongoDB"""
 from loguru import logger
 from pymongo import MongoClient
+from pymongo.collection import Collection
 
 from . import utils
 
@@ -10,39 +11,41 @@ class Mongo():
 
     client = MongoClient()
 
-    def close(self):
+    def close(self) -> bool:
         """client close"""
         try:
             self.client.close()
+            return True
         except Exception as e:
             logger.exception(e)
+            return False
 
-    def connect_test(self, debug: bool = False):
-        """client connect test"""
-        info = 'MongoDB连接测试'
+    def connect_test(self) -> bool:
+        info = "MongoDB connect test"
         try:
-            logger.info(f'{info}[执行]')
+            logger.info(f"{info} ......")
             self.client.server_info()
-            logger.success(f'{info}[成功]')
+            logger.success(f"{info} [success]")
             return True
         except Exception as e:
-            logger.error(f'{info}[失败]')
-            if utils.v_true(debug, bool):
-                logger.exception(e)
+            logger.error(f"{info} [failed]")
+            logger.exception(e)
             return False
 
-    def collection(self, database, name):
-        """client collection"""
-        return self.client[database][name]
+    def collection(self, database: str, name: str) -> Collection | None:
+        try:
+            return self.client[database][name]
+        except Exception as e:
+            logger.exception(e)
+            return None
 
-    def collection_insert(self, database, collection, data, drop=None):
-        """client collection insert"""
+    def collection_insert(self, database, collection, data, drop: bool = False):
         db_collection = self.client[database][collection]
-        info = '插入数据'
+        info = "MongoDB collection insert"
         try:
-            logger.info(f'{info}[执行]')
+            logger.info(f"{info} ......")
             # 是否删除 collection
-            if drop is True:
+            if utils.v_true(drop, bool):
                 # 删除 collection
                 db_collection.drop()
             # 插入数据
@@ -53,12 +56,12 @@ class Mongo():
                 # 插入多条数据
                 result = db_collection.insert_many(data)
             else:
-                logger.error(f'{info}[失败]')
-                logger.error('数据类型错误')
+                logger.error(f"{info} [failed]")
+                logger.error("Data type error")
                 return False
-            logger.success(f'{info}[成功]')
+            logger.success(f"{info} [success]")
             return result
         except Exception as e:
-            logger.error(f'{info}[失败]')
+            logger.error(f"{info} [failed]")
             logger.exception(e)
             return False

{ezkit-1.7.6 → ezkit-1.7.8}/ezKit/qywx.py

@@ -1,3 +1,14 @@
+"""
+企业微信开发者中心
+
+    https://developer.work.weixin.qq.com/
+    https://developer.work.weixin.qq.com/document/path/90313 (全局错误码)
+
+参考文档:
+
+    https://www.gaoyuanqi.cn/python-yingyong-qiyewx/
+    https://www.jianshu.com/p/020709b130d3
+"""
 import json
 import time
 
@@ -7,21 +18,9 @@ from loguru import logger
 from . import utils
 
 
-class QYWX(object):
+class QYWX:
     """企业微信"""
 
-    """
-    企业微信开发者中心
-
-        https://developer.work.weixin.qq.com/
-        https://developer.work.weixin.qq.com/document/path/90313 (全局错误码)
-
-    参考文档:
-
-        https://www.gaoyuanqi.cn/python-yingyong-qiyewx/
-        https://www.jianshu.com/p/020709b130d3
-    """
-
     url_prefix = 'https://qyapi.weixin.qq.com'
     work_id: str | None = None
     agent_id: str | None = None

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

@@ -1,10 +1,12 @@
+"""Redis"""
 import redis as RedisClient
 from loguru import logger
 
 from . import utils
 
 
-class Redis(object):
+class Redis:
+    """Redis"""
 
     # https://redis.readthedocs.io/en/stable/_modules/redis/client.html#Redis
     # https://github.com/redis/redis-py#client-classes-redis-and-strictredis
@@ -14,38 +16,38 @@ class Redis(object):
     # 这里修改以下参数: host, port, socket_timeout, socket_connect_timeout, charset
     redis = RedisClient.Redis()
 
-    def __init__(self, arguments=None):
-        '''Initiation'''
-        if utils.v_true(arguments, str):
+    def __init__(self, arguments: str | dict):
+        """Initiation"""
+        if isinstance(arguments, str) and utils.v_true(arguments, str):
             self.redis = RedisClient.from_url(arguments)
-        elif utils.v_true(arguments, dict):
+
+        if isinstance(arguments, dict) and utils.v_true(arguments, dict):
             self.redis = RedisClient.Redis(**arguments)
-        else:
-            pass
 
-    def connect_test(self):
-        info = 'Redis连接测试'
+    def connect_test(self) -> bool:
+        info = "Redis connect test"
         try:
-            logger.info(f'{info}......')
+            logger.info(f"{info} ......")
             self.redis.ping()
-            logger.success(f'{info}[成功]')
+            logger.success(f"{info} [success]")
             return True
         except Exception as e:
-            logger.error(f'{info}[失败]')
+            logger.error(f"{info} [failed]")
             logger.exception(e)
             return False
 
-    def flush(self, all=None):
-        info = 'Redis数据清理'
+    def flush(self, flushall: bool = False) -> bool:
+        info = "Redis flush"
         try:
-            logger.info(f'{info}......')
-            if all == True:
+            if utils.v_true(flushall, bool):
+                logger.info(f"{info} all ......")
                 self.redis.flushall()
             else:
+                logger.info(f"{info} db ......")
                 self.redis.flushdb()
-            logger.success(f'{info}[成功]')
+            logger.success(f"{info} [success]")
             return True
         except Exception as e:
-            logger.error(f'{info}[失败]')
+            logger.error(f"{info} [failed]")
             logger.exception(e)
             return False

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

@@ -1,6 +1,4 @@
-"""
-发送邮件
-"""
+"""发送邮件"""
 # https://stackoverflow.com/questions/882712/sending-html-email-using-python
 # pylint: disable=E0611
 # pylint: disable=R0911

ezkit-1.7.8/ezKit/token.py

@@ -0,0 +1,77 @@
+"""Token"""
+import json
+from typing import Any
+
+from loguru import logger
+
+from . import cipher, utils
+
+
+def generate_token(key: str = 'Fc0zXCmGKd7tPu6W', timeout: int = 3600, data: Any = None) -> (str | None):
+    try:
+        now = utils.datetime_now()
+
+        if now is None:
+            return None
+
+        offset = utils.datetime_offset(now, seconds=+timeout)
+
+        if offset is None:
+            return None
+
+        source = json.dumps(
+            obj={
+                "datetime": utils.datetime_to_string(offset),
+                "data": data
+            },
+            default=str
+        )
+
+        aes_cipher = cipher.AESCipher(key=key, algorithm='sha256')
+
+        return aes_cipher.encrypt(source)
+
+    except Exception as e:
+        logger.exception(e)
+        return None
+
+
+def parsing_token(token_string: str, key: str = 'Fc0zXCmGKd7tPu6W') -> (dict | None):
+    try:
+        if utils.v_true(token_string, str) is False:
+            return None
+
+        aes_cipher = cipher.AESCipher(key=key, algorithm='sha256')
+
+        target = aes_cipher.decrypt(token_string)
+
+        if target is None:
+            return None
+
+        source: dict = json.loads(target)
+
+        source['datetime'] = utils.datetime_string_to_datetime(source['datetime'])
+
+        return source
+
+    except Exception as e:
+        logger.exception(e)
+        return None
+
+
+def certify_token(token_string: str, key: str = 'Fc0zXCmGKd7tPu6W') -> bool:
+    try:
+
+        result = parsing_token(token_string, key)
+
+        if result is None:
+            return False
+
+        if result.get('datetime') < utils.datetime_now():  # type: ignore
+            return False
+
+        return True
+
+    except Exception as e:
+        logger.exception(e)
+        return False

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

@@ -1,6 +1,4 @@
-"""
-Python Utils
-"""
+"""Utils"""
 import csv
 import datetime
 import hashlib
@@ -49,6 +47,10 @@ def v_true(
         List        list/tuple/set  []/()/{}
         Dictionary  dict            {}
 
+    查看变量类型: type(x)
+
+    判断变量类型: isinstance(x, str)
+
     函数使用 callable(func) 判断
     """
 
@@ -623,7 +625,7 @@ def dict_remove_key(
     data: dict,
     key: str,
     debug: bool = False
-) -> None | dict:
+) -> dict | None:
     """dict remove key"""
     try:
         data_copy: dict = deepcopy(data)
@@ -984,7 +986,9 @@ def datetime_now(
     """获取当前日期和时间"""
     _utc = kwargs.pop("utc", False)
     try:
-        return datetime.datetime.utcnow() if _utc is True else datetime.datetime.now(**kwargs)
+        if _utc is True:
+            return datetime.datetime.now(datetime.timezone.utc)
+        return datetime.datetime.now(**kwargs)
     except Exception as e:
         if v_true(debug, bool):
             logger.exception(e)
@@ -992,7 +996,7 @@ def datetime_now(
 
 
 def datetime_offset(
-    datetime_instance: datetime.datetime,
+    datetime_instance: datetime.datetime | None = None,
     debug: bool = False,
     **kwargs
 ) -> datetime.datetime | None:
@@ -1005,7 +1009,12 @@ def datetime_offset(
     try:
         if isinstance(datetime_instance, datetime.datetime):
             return datetime_instance + datetime.timedelta(**kwargs)
-        return datetime.datetime.utcnow() + datetime.timedelta(**kwargs) if _utc is True else datetime.datetime.now() + datetime.timedelta(**kwargs)
+
+        if _utc is True:
+            return datetime.datetime.now(datetime.timezone.utc) + datetime.timedelta(**kwargs)
+
+        return datetime.datetime.now() + datetime.timedelta(**kwargs)
+
     except Exception as e:
         if v_true(debug, bool):
             logger.exception(e)

ezkit-1.7.8/ezKit/xftp.py

@@ -0,0 +1,222 @@
+"""
+ftplib: https://docs.python.org/3.11/library/ftplib.html
+"""
+import os
+from ftplib import FTP
+from pathlib import Path
+
+from loguru import logger
+
+
+class XFTP:
+    """XFTP"""
+
+    def __init__(self, host="127.0.0.1", port=21, username="anonymous", password="", encoding="UTF-8", debuglevel=0):
+        """Initiation"""
+        self.ftp = FTP()
+        self.ftp.set_debuglevel(debuglevel)
+        self.host = host
+        self.port = port
+        self.username = username
+        self.password = password
+        self.encoding = encoding
+        self.retry = 1
+
+    def connect(self) -> bool:
+        """FTP connect"""
+        try:
+            self.ftp.connect(host=self.host, port=self.port, timeout=10)
+            self.ftp.encoding = self.encoding
+            self.ftp.login(user=self.username, passwd=self.password)
+            logger.success("FTP connect success")
+            logger.info("-" * 80)
+            return True
+        except Exception as e:
+            # print(f"FTP connect error: {e}, retry...")
+            # if self.retry >= 3:
+            #     print("FTP connect faild")
+            #     return False
+            # self.retry += 1
+            # self.connect()
+            logger.exception(e)
+            return False
+
+    def close(self, info=None) -> bool:
+        """FTP close"""
+        if info is not None:
+            logger.info(info)
+        try:
+            self.ftp.quit()
+        except Exception as e:
+            logger.exception(e)
+            self.ftp.close()
+        logger.info("-" * 80)
+        logger.success("FTP connect closed")
+        return True
+
+    def get_file_list(self, target='/') -> list[str] | None:
+        """Get file list"""
+        try:
+            self.chdir_to_remote(target)
+            return self.ftp.nlst()
+        except Exception as e:
+            logger.exception(e)
+            return None
+
+    def get_file_size(self, file, target="/") -> int | None:
+        """Get file size"""
+        try:
+            self.chdir_to_remote(target)
+            return self.ftp.size(file)
+        except Exception as e:
+            logger.exception(e)
+            return None
+
+    def mkdir(self, target="/") -> bool:
+        """创建目录 (从 / 目录依次递增创建子目录. 如果目录存在, 创建目录时会报错, 所以这里忽略所有错误.)"""
+        try:
+            dir_list = target.split("/")
+            for i, _ in enumerate(dir_list):
+                dir_path = "/".join(dir_list[:i + 1])
+                try:
+                    self.ftp.mkd(dir_path)
+                except Exception as e:
+                    logger.exception(e)
+            return True
+        except Exception as e:
+            logger.exception(e)
+            return False
+
+    def chdir_to_remote(self, target="/") -> bool:
+        """change to remote directory"""
+        try:
+            self.ftp.cwd(target)
+            return True
+        except Exception as e:
+            self.close(f"remote directory error: {target}")
+            logger.exception(e)
+            return False
+
+    def x_exit(self, info=None):
+        """Exit"""
+        if info is not None:
+            logger.info(info)
+        # 注意: exit() 并不会退出脚本, 配合 try 使用
+        exit()
+
+    def x_exec(self, local_dir=".", local_file="", remote_dir="/", remote_file="", upload=False):
+        """Download or Upload"""
+
+        bufsize = 1024
+        local_path = f"{local_dir}/{local_file}"
+        remote_path = f"{remote_dir}/{remote_file}"
+
+        info = 'Download'
+        if upload is True:
+            info = 'Upload'
+
+        # 检查参数
+        if upload is True:
+            if local_file == "":
+                self.close('Argument Miss: local file')
+            # 如果没有设置 远程文件 名称, 则使用 本地文件 名称
+            if remote_file == "":
+                remote_file = local_file
+                remote_path = f"{remote_dir}/{remote_file}"
+        else:
+            if remote_file == "":
+                self.close("Argument Miss: remote file")
+            # 如果没有设置 本地文件 名称, 则使用 远程文件 名称
+            if local_file == "":
+                local_file = remote_file
+                local_path = f"{local_dir}/{local_file}"
+
+        # 进入本地目录
+        try:
+            if upload is True:
+                # 检查本地目录
+                stat = Path(local_dir)
+                if stat.exists() is False:
+                    self.close(f"Local directory error: {local_dir}")
+            else:
+                # 创建本地目录
+                Path(local_dir).mkdir(parents=True, exist_ok=True)
+            # 进入本地目录
+            os.chdir(local_dir)
+        except Exception as e:
+            logger.exception(e)
+            # 第一层 try 使用 self.x_exit() 无效, 直接使用 self.close()
+            self.close(f"Local directory error: {local_dir}")
+
+        # 上传或下载
+        try:
+
+            if upload is True:
+
+                # 上传
+
+                # 创建远程目录
+                if remote_dir != "/":
+                    self.mkdir(remote_dir)
+
+                # 进入远程目录
+                self.chdir_to_remote(remote_dir)
+
+                # 上传文件
+                stat = Path(local_file)
+                if stat.exists() and stat.is_file():
+                    with open(local_file, "rb") as fid:
+                        self.ftp.storbinary(f'STOR {remote_file}', fid, bufsize)
+                    logger.success(f"{info} success: {local_path.replace('//', '/')} -> {remote_path.replace('//', '/')}")
+                    return True
+
+                self.x_exit(f"{info} error: {local_path.replace('//', '/')} is not exist")
+
+            else:
+
+                # 下载
+
+                # 进入远程目录
+                self.chdir_to_remote(remote_dir)
+
+                # 下载文件
+                if remote_file in self.ftp.nlst():
+                    with open(local_file, "wb") as fid:
+                        self.ftp.retrbinary(f'RETR {remote_file}', fid.write, bufsize)
+                    logger.success(f"{info} success: {remote_path.replace('//', '/')} -> {local_path.replace('//', '/')}")
+                    return True
+
+                self.x_exit(f"{info} error: {remote_path.replace('//', '/')} is not exist")
+
+        except Exception as e:
+            # 第一层 try 使用 self.x_exit() 无效, 直接使用 self.close()
+            # self.close('{} faild! Please check {} or {}'.format(info, local_path, remote_path))
+            self.close(f"{info} error: {e}")
+            return False
+
+    def handle_all(self, local_dir=".", remote_dir="/", upload=False):
+        """Handle All"""
+        if upload is True:
+            # 检查本地目录
+            stat = Path(local_dir)
+            if stat.exists() is False:
+                self.close(f"Local directory error: {local_dir}")
+            # 获取文件列表
+            local_files = [f for f in os.listdir(local_dir) if os.path.isfile(os.path.join(local_dir, f))]
+            for i in local_files:
+                self.x_exec(local_dir=local_dir, remote_dir=remote_dir, local_file=i, upload=True)
+        else:
+            remote_files = self.get_file_list(remote_dir)
+            if remote_files is not None:
+                for i in remote_files:
+                    self.x_exec(local_dir=local_dir, remote_dir=remote_dir, remote_file=i)
+
+    def retrlines(self, remote_dir="/", cmd="LIST"):
+        """Retrlines"""
+        try:
+            self.chdir_to_remote(remote_dir)
+            print(self.ftp.retrlines(cmd))
+            self.close()
+        except Exception as e:
+            # 第一层 try 使用 self.x_exit() 无效, 直接使用 self.close()
+            self.close(e)

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

@@ -1,8 +1,9 @@
 Metadata-Version: 2.1
 Name: ezKit
-Version: 1.7.6
+Version: 1.7.8
 Summary: Easy Kit
 Author: septvean
 Author-email: septvean@gmail.com
 Requires-Python: >=3.11
 License-File: LICENSE
+Requires-Dist: loguru>=0.7.0

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

@@ -22,4 +22,5 @@ ezKit/zabbix.py
 ezKit.egg-info/PKG-INFO
 ezKit.egg-info/SOURCES.txt
 ezKit.egg-info/dependency_links.txt
+ezKit.egg-info/requires.txt
 ezKit.egg-info/top_level.txt

ezkit-1.7.8/ezKit.egg-info/requires.txt

@@ -0,0 +1 @@
+loguru>=0.7.0

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

@@ -3,15 +3,14 @@ from setuptools import find_packages, setup
 
 setup(
     name='ezKit',
-    version='1.7.6',
+    version='1.7.8',
     author='septvean',
     author_email='septvean@gmail.com',
     description='Easy Kit',
     packages=find_packages(exclude=['documents', 'tests']),
     include_package_data=True,
-    python_requires='>=3.11'
-    # install_requires=[
-    #     'loguru>=0.7.0',
-    #     'tomlkit>=0.12.0'
-    # ]
+    python_requires='>=3.11',
+    install_requires=[
+        "loguru>=0.7.0"
+    ]
 )

ezkit-1.7.6/README.md

@@ -1,234 +0,0 @@
-# Python Easy Kit
-
-保留关键字:
-
-- <https://docs.python.org/3.10/reference/lexical_analysis.html#keywords>
-
-```py
-import keyword
-keyword.kwlist
-
-"""
-[
-    'False', 'None', 'True', 'and', 'as', 'assert', 'async', 'await', 'break', 'class', 'continue',
-    'def', 'del', 'elif', 'else', 'except', 'finally', 'for', 'from', 'global', 'if', 'import', 'in', 'is',
-    'lambda', 'nonlocal', 'not', 'or', 'pass', 'raise', 'return', 'try', 'while', 'with', 'yield'
-]
-```
-
-内置函数:
-
-- <https://docs.python.org/3.10/library/functions.html>
-
-Built-in Functions
-
-```py
-# A
-abs()
-aiter()
-all()
-any()
-anext()
-ascii()
-
-# B
-bin()
-bool()
-breakpoint()
-bytearray()
-bytes()
-
-# C
-callable()
-chr()
-classmethod()
-compile()
-complex()
-
-# D
-delattr()
-dict()
-dir()
-divmod()
-
-# E
-enumerate()
-eval()
-exec()
-
-# F
-filter()
-float()
-format()
-frozenset()
-
-# G
-getattr()
-globals()
-
-# H
-hasattr()
-hash()
-help()
-hex()
-
-# I
-id()
-input()
-int()
-isinstance()
-issubclass()
-iter()
-
-# L
-len()
-list()
-locals()
-
-# M
-map()
-max()
-memoryview()
-min()
-
-# N
-next()
-
-# O
-object()
-oct()
-open()
-ord()
-
-# P
-pow()
-print()
-property()
-
-# R
-range()
-repr()
-reversed()
-round()
-
-# S
-set()
-setattr()
-slice()
-sorted()
-staticmethod()
-str()
-sum()
-super()
-
-# T
-tuple()
-type()
-
-# V
-vars()
-
-# Z
-zip()
-
-# _
-__import__()
-```
-
-代码规范:
-
-- [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
-
-手动安装:
-
-```sh
-pip install ezKit-1.1.3.tar.gz
-```
-
-版本号说明: [PEP 440 – Version Identification and Dependency Specification](https://peps.python.org/pep-0440/)
-
-## 函数
-
-- 明确 参数 和 返回值 的类型
-- 必须有返回值
-- 添加一个 debug 参数, 用于调试
-    - 如果 debug 为 True, 则输出相关信息, 否则一律不输出任何信息
-- 必须有说明
-- 必须用 try ... except ... 包裹
-
-try ... except ... 一律输出 Exception:
-
-```py
-def func():
-    try:
-        ...
-    except Exception as e:
-        logger.exception(e)
-        return None
-```
-
-Boolen (False)
-
-| Types | False |
-| ---   | ---   |
-| bool  | False |
-| int   | 0     |
-| float | 0.0   |
-| str   | ''    |
-| list  | []    |
-| tuple | ()    |
-| dict  | {}    |
-| set   | {\*()} {\*[]} {\*{}} |
-
-list/tuple/dict/set 初始化和类型转换:
-
-- 变量初始化推荐使用 `[]/()/{}/{*()}/{*[]}/{*{}}` (性能更好)
-- 类型转换则使用具体函数 `list()/tuple()/dict()/set()`
-
-list/tuple/set 的区别:
-
-- list 元素可以改变且可以不唯一
-- tuple 元素不能改变且可以不唯一
-- set 元素可以改变但唯一
-
-变量类型
-
-- 查看变量类型 type(x)
-- 判断变量类型 isinstance(x, str)
-
-函数: 不要判断类型, 否则会捕获不到异常, 无法定位到出问题的地方
-
-函数: 必须有返回
-
-- 有内容返回内容
-- 无内容返回None
-- 仅执行则返回True或False
-
-函数变量
-
-- 建议定义为 None
-- 没有定义变量初始值, 添加 *args, **kwargs
-- 定义了变量初始值, 添加 **kwargs
-- 其它情况 *args, x=None, **kwargs
-- 检查变量类型
-
-配置文件用 JSON, 优点: 简单高效, 保持数据类型, 缺点: 不支持注释
-
-```py
-logger.info('配置文件解析...')
-
-config_file = os.path.realpath(argument_config)
-config_dict = utils.json_file_parser(config_file)
-
-exit(1) if config_dict == None else next
-
-print(config_dict)
-```
-
-## Exit
-
-如果要编译脚本, 代码中有使用 exit 退出脚本时, 将 `exit()` 改为 `sys.exit()`, 否则编译的文件调用 `exit()` 会失败

ezkit-1.7.6/ezKit/__init__.py

@@ -1 +0,0 @@
-# from . import bottle, database, files, plots, utils, weixin, zabbix

ezkit-1.7.6/ezKit/token.py

@@ -1,44 +0,0 @@
-import json
-
-from .cipher import AESCipher
-from .utils import datetime_now, datetime_offset, datetime_string_to_datetime, datetime_to_string, v_true
-
-
-def generate_token(key: str = 'Fc0zXCmGKd7tPu6W', timeout: int = 3600, data: any = None) -> None | str:
-    try:
-        source = json.dumps(
-            obj={
-                'datetime': datetime_to_string(datetime_offset(datetime_now(), seconds=+timeout)),
-                'data': data
-            },
-            default=str
-        )
-        cipher = AESCipher(key=key, algorithm='sha256')
-        return cipher.encrypt(source)
-    except:
-        return None
-
-
-def parsing_token(token_string: str, key: str = 'Fc0zXCmGKd7tPu6W') -> None | dict:
-    try:
-        if v_true(token_string, str):
-            cipher = AESCipher(key=key, algorithm='sha256')
-            source: dict = json.loads(cipher.decrypt(token_string))
-            source['datetime'] = datetime_string_to_datetime(source['datetime'])
-            return source
-        else:
-            return None
-    except:
-        return None
-
-
-def certify_token(token_string: str, key: str = 'Fc0zXCmGKd7tPu6W') -> bool:
-    try:
-        result = parsing_token(token_string, key)
-        if not v_true(result, dict):
-            return False
-        if result.get('datetime') < datetime_now():
-            return False
-        return True
-    except:
-        return False

ezkit-1.7.6/ezKit/xftp.py

@@ -1,194 +0,0 @@
-'''
-ftplib: https://docs.python.org/3.10/library/ftplib.html
-'''
-import os
-from ftplib import FTP
-from pathlib import Path
-
-
-class XFTP:
-
-    def __init__(self, host='127.0.0.1', port=21, username='anonymous', password='', encoding='UTF-8', debuglevel=0):
-        ''' Initiation '''
-        self.ftp = FTP()
-        self.ftp.set_debuglevel(debuglevel)
-        self.host = host
-        self.port = port
-        self.username = username
-        self.password = password
-        self.encoding = encoding
-        self.retry = 1
-
-    def connect(self):
-        ''' FTP connect '''
-        try:
-            self.ftp.connect(host=self.host, port=self.port, timeout=10)
-            self.ftp.encoding = self.encoding
-            self.ftp.login(user=self.username, passwd=self.password)
-            print('FTP connect success')
-            print('-' * 80)
-            return True
-        except Exception as e:
-            print(f'FTP connect error: {e}, retry...')
-            if self.retry >= 3:
-                print('FTP connect faild')
-                return False
-            self.retry += 1
-            self.connect()
-
-    def close(self, info=None):
-        ''' FTP close '''
-        print(info) if info else None
-        try:
-            self.ftp.quit()
-        except:
-            self.ftp.close()
-        print('-' * 80)
-        print('FTP connect closed')
-
-    def get_file_list(self, dir='/'):
-        ''' Get file list '''
-        self.chdir_to_remote(dir)
-        return self.ftp.nlst()
-
-    def get_file_size(self, dir='/', file=None):
-        ''' Get file size '''
-        self.chdir_to_remote(dir)
-        return self.ftp.size(file)
-
-    def mkdir(self, dir_string='/'):
-        ''' 创建目录 (从 / 目录依次递增创建子目录. 如果目录存在, 创建目录时会报错, 所以这里忽略所有错误.) '''
-        try:
-            dir_list = dir_string.split("/")
-            for i, _ in enumerate(dir_list):
-                dir = '/'.join(dir_list[:i + 1])
-                try:
-                    self.ftp.mkd(dir)
-                except:
-                    pass
-            return True
-        except:
-            return False
-
-    def chdir_to_remote(self, dir='/'):
-        ''' change to remote directory'''
-        try:
-            self.ftp.cwd(dir)
-        except:
-            self.close(f'Remote directory error: {dir}')
-
-    def x_exit(self, info=None):
-        ''' Exit '''
-        print(info) if info else None
-        # 注意: exit() 并不会退出脚本, 配合 try 使用
-        exit()
-
-    def x_exec(self, local_dir='.', local_file='', remote_dir='/', remote_file='', upload=False):
-        ''' Download or Upload '''
-
-        bufsize = 1024
-        local_path = local_dir + '/' + local_file
-        remote_path = remote_dir + '/' + remote_file
-        info = 'Upload' if upload else 'Download'
-
-        # 检查参数
-        if upload:
-            if local_file == '':
-                self.close('Argument Miss: local file')
-            # 如果没有设置 远程文件 名称, 则使用 本地文件 名称
-            if remote_file == '':
-                remote_file = local_file
-                remote_path = remote_dir + '/' + remote_file
-        else:
-            if remote_file == '':
-                self.close('Argument Miss: remote file')
-            # 如果没有设置 本地文件 名称, 则使用 远程文件 名称
-            if local_file == '':
-                local_file = remote_file
-                local_path = local_dir + '/' + local_file
-
-        # 进入本地目录
-        try:
-            if upload:
-                # 检查本地目录
-                stat = Path(local_dir)
-                self.close(f'Local directory error: {local_dir}') if stat.exists() == False else None
-            else:
-                # 创建本地目录
-                Path(local_dir).mkdir(parents=True, exist_ok=True)
-            # 进入本地目录
-            os.chdir(local_dir)
-        except:
-            # 第一层 try 使用 self.x_exit() 无效, 直接使用 self.close()
-            self.close(f'Local directory error: {local_dir}')
-
-        # 上传或下载
-        try:
-
-            if upload:
-
-                ''' 上传 '''
-
-                # 创建远程目录
-                if remote_dir != '/':
-                    self.mkdir(remote_dir)
-
-                # 进入远程目录
-                self.chdir_to_remote(remote_dir)
-
-                # 上传文件
-                stat = Path(local_file)
-                if stat.exists() and stat.is_file():
-                    with open(local_file, 'rb') as fid:
-                        self.ftp.storbinary(f'STOR {remote_file}', fid, bufsize)
-                    print('{} success: {} -> {}'.format(info, local_path.replace('//', '/'), remote_path.replace('//', '/')))
-                    return True
-                else:
-                    self.x_exit('{} error: {} is not exist'.format(info, local_path.replace('//', '/')))
-
-            else:
-
-                ''' 下载 '''
-
-                # 进入远程目录
-                self.chdir_to_remote(remote_dir)
-
-                # 下载文件
-                if remote_file in self.ftp.nlst():
-                    with open(local_file, 'wb') as fid:
-                        self.ftp.retrbinary(f'RETR {remote_file}', fid.write, bufsize)
-                    print('{} success: {} -> {}'.format(info, remote_path.replace('//', '/'), local_path.replace('//', '/')))
-                    return True
-                else:
-                    self.x_exit('{} error: {} is not exist'.format(info, remote_path.replace('//', '/')))
-
-        except Exception as e:
-            # 第一层 try 使用 self.x_exit() 无效, 直接使用 self.close()
-            # self.close('{} faild! Please check {} or {}'.format(info, local_path, remote_path))
-            self.close(f'{info} error: {e}')
-            return False
-
-    def handle_all(self, local_dir='.', remote_dir='/', upload=False):
-        ''' Handle All '''
-        if upload:
-            # 检查本地目录
-            stat = Path(local_dir)
-            self.close(f'Local directory error: {local_dir}') if stat.exists() == False else None
-            # 获取文件列表
-            local_files = [f for f in os.listdir(local_dir) if os.path.isfile(os.path.join(local_dir, f))]
-            for i in local_files:
-                self.x_exec(local_dir=local_dir, remote_dir=remote_dir, local_file=i, upload=True)
-        else:
-            remote_files = self.get_file_list(remote_dir)
-            for i in remote_files:
-                self.x_exec(local_dir=local_dir, remote_dir=remote_dir, remote_file=i)
-
-    def retrlines(self, remote_dir='/', cmd='LIST'):
-        ''' Retrlines '''
-        try:
-            self.chdir_to_remote(remote_dir)
-            print(self.ftp.retrlines(cmd))
-            self.close()
-        except Exception as e:
-            # 第一层 try 使用 self.x_exit() 无效, 直接使用 self.close()
-            self.close(e)