ezKit 1.7.0__py3-none-any.whl → 1.7.1__py3-none-any.whl

ezKit/utils.py

@@ -14,7 +14,7 @@ from multiprocessing.pool import ThreadPool
 from pathlib import Path
 from shutil import rmtree
 from threading import Thread
-from typing import Callable
+from typing import Any, Callable, List, Optional, Union
 from urllib.parse import ParseResult, urlparse
 from uuid import uuid4
 
@@ -32,46 +32,55 @@ NoneType = type(None)
 
 
 def v_true(
-    v_instance: any,
-    v_type: any = None,
+    v_instance: Any,
+    v_type: Any = None,
     true_list: list | tuple | set | str | None = None,
     false_list: list | tuple | set | str | None = None,
     debug: bool = False
 ) -> bool:
     """
-    检查变量类型以及变量是否为True
+    检查变量类型以及变量是否为 True
+
+    常见类型:
+
+        Boolean     bool            False
+        Numbers     int/float       0/0.0
+        String      str             ""
+        List        list/tuple/set  []/()/{}
+        Dictionary  dict            {}
+
+    函数使用 callable(func) 判断
     """
-    # 常见类型:
-    #     Boolean     bool            False
-    #     Numbers     int/float       0/0.0
-    #     String      str             ""
-    #     List        list/tuple/set  []/()/{}
-    #     Dictionary  dict            {}
-    # 函数使用 callable(func) 判断
 
     try:
 
         if isinstance(v_instance, v_type):
 
             if all(
-                true_list is not None,
-                false_list is None,
-                isinstance(true_list, (list, tuple, set, str))
+                [
+                    true_list is not None,
+                    false_list is None,
+                    isinstance(true_list, (list, tuple, set, str))
+                ]
             ):
                 return v_instance in true_list
 
             if all(
-                true_list is None,
-                false_list is not None,
-                isinstance(false_list, (list, tuple, set, str))
+                [
+                    true_list is None,
+                    false_list is not None,
+                    isinstance(false_list, (list, tuple, set, str))
+                ]
             ):
                 return v_instance not in false_list
 
             if all(
-                true_list is not None,
-                false_list is not None,
-                isinstance(true_list, (list, tuple, set, str)),
-                isinstance(false_list, (list, tuple, set, str))
+                [
+                    true_list is not None,
+                    false_list is not None,
+                    isinstance(true_list, (list, tuple, set, str)),
+                    isinstance(false_list, (list, tuple, set, str))
+                ]
             ):
                 return (v_instance in true_list) and (v_instance not in false_list)
 
@@ -85,25 +94,43 @@ def v_true(
         return False
 
 
+# --------------------------------------------------------------------------------------------------
+
+
 def os_environ(
     name: str,
-    value: any = None,
+    value: Any = None,
     debug: bool = False
-) -> any:
-    """伪全局变量"""
-    # Python 没有全局变量, 多个文件无法调用同一个变量
-    # 为了解决这个问题, 将变量设置为系统变量, 从而实现多个文件调用同一个变量
+) -> Any:
+    """
+    系统变量
+
+    伪全局变量
+    Python 没有全局变量, 多个文件无法调用同一个变量.
+    为了解决这个问题, 将变量设置为系统变量, 从而实现多个文件调用同一个变量.
+    """
     try:
 
         # 变量名添加一个前缀, 防止和系统中其它变量名冲突
-        variable_name = f'PYTHON_VARIABLE_{name}'
+        _variable_name = f'PYTHON_VARIABLE_{name}'
 
         if value is None:
-            data = os.environ.get(variable_name)
-            return json.loads(data)
 
-        data = json.dumps(value)
-        os.environ[variable_name] = data
+            _data = os.environ.get(_variable_name)
+
+            # 判断是否有数据
+            if _data:
+                try:
+                    # 如果环境变量有值, 使用 json.loads() 解析
+                    parsed_data = json.loads(_data)
+                    return parsed_data
+                except json.JSONDecodeError:
+                    return None
+            else:
+                return None
+
+        _data = json.dumps(value)
+        os.environ[_variable_name] = _data
 
         return value
 
@@ -121,10 +148,14 @@ def mam_of_numbers(
     dest_type: str | None = None,
     debug: bool = False
 ) -> tuple[int | float, int | float, int | float] | tuple[None, None, None]:
-    """(maximum, average, minimum)"""
-    # 返回一组数字中的 最大值(maximum), 平均值(average), 最小值(minimum)
-    # numbers 数字列表 (仅支持 list 和 tuple, 不支 set)
-    # dest_type 目标类型 (将数字列表中的数字转换成统一的类型)
+    """
+    (maximum, average, minimum)
+
+    返回一组数字中的 最大值(maximum), 平均值(average), 最小值(minimum)
+    numbers 数字列表 (仅支持 list 和 tuple, 不支 set)
+    dest_type 目标类型 (将数字列表中的数字转换成统一的类型)
+    """
+
     try:
         _numbers = deepcopy(numbers)
         match True:
@@ -142,24 +173,31 @@ def mam_of_numbers(
         return None, None, None
 
 
+# --------------------------------------------------------------------------------------------------
+
+
 def step_number_for_split_equally(
     integer: int,
     split_equally_number: int,
     debug: bool = False
 ) -> int | None:
-    """step number for split equally"""
-    # 平分数字的步长
-    #   integer 数字
-    #   split_equally_number 平分 integer 的数字
-    #
-    # 示例:
-    #
-    #     [1, 2, 3, 4, 5, 6, 7, 8, 9]
-    #
-    #     分成 2 份 -> [[1, 2, 3, 4, 5], [6, 7, 8, 9]] -> 返回 5
-    #     分成 3 份 -> [[1, 2, 3], [4, 5, 6], [7, 8, 9]] -> 返回 3
-    #     分成 4 份 -> [[1, 2, 3], [4, 5], [6, 7], [8, 9]] -> 返回 3
-    #     分成 5 份 -> [[1, 2], [3, 4], [5, 6], [7, 8], [9]] -> 返回 2
+    """
+    step number for split equally
+
+    平分数字的步长
+
+      integer 数字
+      split_equally_number 平分 integer 的数字
+
+    示例:
+
+        [1, 2, 3, 4, 5, 6, 7, 8, 9]
+
+        分成 2 份 -> [[1, 2, 3, 4, 5], [6, 7, 8, 9]]        -> 返回 5
+        分成 3 份 -> [[1, 2, 3], [4, 5, 6], [7, 8, 9]]      -> 返回 3
+        分成 4 份 -> [[1, 2, 3], [4, 5], [6, 7], [8, 9]]    -> 返回 3
+        分成 5 份 -> [[1, 2], [3, 4], [5, 6], [7, 8], [9]]  -> 返回 2
+    """
     try:
         if integer % split_equally_number == 0:
             return int(integer / split_equally_number)
@@ -170,6 +208,9 @@ def step_number_for_split_equally(
         return None
 
 
+# --------------------------------------------------------------------------------------------------
+
+
 def division(
     dividend: int | float,
     divisor: int | float,
@@ -245,38 +286,47 @@ def check_file_type(
     file_object: str,
     file_type: str,
     debug: bool = False
-) -> bool | None:
-    """check file type"""
-    # 检查文件类型
-    # file_object 文件对象
-    # file_type 文件类型
+) -> bool:
+    """
+    check file type
+
+    检查文件类型
+
+        file_object 文件对象
+        file_type 文件类型
+    """
     try:
+
         _file_path = Path(file_object)
+
         match True:
             case True if _file_path.exists() is False:
-                return False
+                result = False
             case True if file_type == 'absolute' and _file_path.is_absolute() is True:
-                return True
+                result = True
             case True if file_type == 'block_device' and _file_path.is_block_device() is True:
-                return True
+                result = True
             case True if file_type == 'dir' and _file_path.is_dir() is True:
-                return True
+                result = True
             case True if file_type == 'fifo' and _file_path.is_fifo() is True:
-                return True
+                result = True
             case True if file_type == 'file' and _file_path.is_file() is True:
-                return True
+                result = True
             case True if file_type == 'mount' and _file_path.is_mount() is True:
-                return True
+                result = True
             case True if file_type == 'relative_to' and _file_path.is_relative_to() is True:
-                return True
+                result = True
             case True if file_type == 'reserved' and _file_path.is_reserved() is True:
-                return True
+                result = True
             case True if file_type == 'socket' and _file_path.is_socket() is True:
-                return True
+                result = True
             case True if file_type == 'symlink' and _file_path.is_symlink() is True:
-                return True
+                result = True
             case _:
-                return False
+                result = False
+
+        return result
+
     except Exception as e:
         if v_true(debug, bool):
             logger.exception(e)
@@ -370,11 +420,15 @@ def list_split(
 
         # 数据拷贝
         _data_object = deepcopy(data)
+
         # 数据长度
         _data_length = len(_data_object)
+
         # 数据平分后的结果
         _data_result = []
 
+        _step_number: Optional[int] = None
+
         if v_true(debug, bool):
             logger.info(f"data object: {_data_object}")
             logger.info(f"data length: {_data_length}")
@@ -392,7 +446,6 @@ def list_split(
 
             if equally is True:
 
-                # 数据平分时, 每份数据的最大长度
                 _step_number = step_number_for_split_equally(_data_length, number, debug=debug)
 
                 if v_true(debug, bool):
@@ -415,15 +468,16 @@ def list_split(
                 else:
 
                     # 前一部分
-                    previous_end_number = (_data_length % number) * _step_number
-                    previous_index_number_list = list(range(0, previous_end_number, _step_number))
-                    for index_number in previous_index_number_list:
-                        _data_result.append(deepcopy(_data_object[index_number:index_number + _step_number]))
+                    if _step_number is not None:
+                        previous_end_number = (_data_length % number) * _step_number
+                        previous_index_number_list = list(range(0, previous_end_number, _step_number))
+                        for index_number in previous_index_number_list:
+                            _data_result.append(deepcopy(_data_object[index_number:index_number + _step_number]))
 
-                    # 后一部分
-                    next_number_list = list(range(previous_end_number, _data_length, _step_number - 1))
-                    for index_number in next_number_list:
-                        _data_result.append(deepcopy(_data_object[index_number:index_number + (_step_number - 1)]))
+                        # 后一部分
+                        next_number_list = list(range(previous_end_number, _data_length, _step_number - 1))
+                        for index_number in next_number_list:
+                            _data_result.append(deepcopy(_data_object[index_number:index_number + (_step_number - 1)]))
 
             else:
 
@@ -444,13 +498,23 @@ def list_print_by_step(
     separator: str | None = None,
     debug: bool = False
 ) -> bool:
-    """list print by step"""
-    # 列表按照 步长 和 分隔符 有规律的输出
+    """
+    list print by step
+
+    列表按照 步长 和 分隔符 有规律的输出
+    """
     try:
+
         _data_list = list_split(data, number, debug=debug)
+
+        if _data_list is None:
+            return False
+
         for _item in _data_list:
             print(*_item, sep=separator)
+
         return True
+
     except Exception as e:
         if v_true(debug, bool):
             logger.exception(e)
@@ -521,7 +585,7 @@ def list_to_csvfile(
             # CRLF replaced by LF
             # https://stackoverflow.com/a/29976091
             outcsv = csv.writer(_file, lineterminator=os.linesep, **kwargs)
-            if v_true(fields, list):
+            if v_true(fields, list) and fields is not None:
                 outcsv.writerow(fields)
             outcsv.writerows(data)
         return True
@@ -591,32 +655,35 @@ def dict_to_file(
 def dict_nested_update(
     data: dict,
     key: str,
-    value: any,
+    value: Any,
     debug: bool = False
 ) -> bool:
     """dict nested update"""
     # dictionary nested update
     # https://stackoverflow.com/a/58885744
     try:
-        if v_true(data, dict, debug=debug):
-            for _k, _v in data.items():
-                # callable() 判断是非为 function
-                if (key is not None and key == _k) or (callable(key) is True and key() == _k):
-                    if callable(value) is True:
-                        data[_k] = value()
-                    else:
-                        data[_k] = value
-                elif isinstance(_v, dict) is True:
-                    dict_nested_update(_v, key, value)
-                elif isinstance(_v, list) is True:
-                    for _o in _v:
-                        if isinstance(_o, dict):
-                            dict_nested_update(_o, key, value)
-                else:
-                    pass
-        else:
+
+        if not v_true(data, dict, debug=debug):
             return False
+
+        for _k, _v in data.items():
+            # callable() 判断是非为 function
+            if (key is not None and key == _k) or (callable(key) is True and key == _k):
+                if callable(value) is True:
+                    data[_k] = value()
+                else:
+                    data[_k] = value
+            elif isinstance(_v, dict) is True:
+                dict_nested_update(_v, key, value)
+            elif isinstance(_v, list) is True:
+                for _o in _v:
+                    if isinstance(_o, dict):
+                        dict_nested_update(_o, key, value)
+            else:
+                pass
+
         return True
+
     except Exception as e:
         if v_true(debug, bool):
             logger.exception(e)
@@ -691,10 +758,10 @@ def filehash(
                     file_hash = hashlib.sha3_384()
                 case True if sha == 'sha3_512':
                     file_hash = hashlib.sha3_512()
-                case True if sha == 'shake_128':
-                    file_hash = hashlib.shake_128()
-                case True if sha == 'shake_256':
-                    file_hash = hashlib.shake_256()
+                # case True if sha == 'shake_128':
+                #     file_hash = hashlib.shake_128()
+                # case True if sha == 'shake_256':
+                #     file_hash = hashlib.shake_256()
                 case _:
                     file_hash = hashlib.md5()
             # 建议设置为和 block size 相同的值, 多数系统默认为 4096, 可使用 stat 命令查看
@@ -966,7 +1033,7 @@ def datetime_local_to_timezone(
 
 def datetime_utc_to_timezone(
     datetime_instance: datetime.datetime,
-    tz: datetime.timezone = datetime.datetime.now(datetime.timezone.utc).astimezone().tzinfo,
+    tz: Any = datetime.datetime.now(datetime.timezone.utc).astimezone().tzinfo,
     debug: bool = False
 ) -> datetime.datetime | None:
     """
@@ -1140,7 +1207,7 @@ def json_sort(
     string: str,
     debug: bool = False,
     **kwargs
-) -> dict | None:
+) -> str | None:
     """JSON Sort"""
     try:
         return json.dumps(json.loads(string), indent=4, sort_keys=True, **kwargs) if v_true(string, str, debug=debug) else None
@@ -1154,13 +1221,13 @@ def json_sort(
 
 
 def delete_files(
-    files: str | list,
+    files: Union[str, List],
     debug: bool = False
 ) -> bool:
     """删除文件"""
     try:
 
-        if v_true(files, str, debug=debug) and check_file_type(files, 'file', debug=debug):
+        if isinstance(files, str) and check_file_type(files, 'file', debug=debug):
 
             os.remove(files)
             if v_true(debug, bool):
@@ -1194,7 +1261,7 @@ def delete_files(
 
 
 def delete_directory(
-    directory: str | list,
+    directory: Union[str, List],
     debug: bool = False
 ) -> bool:
     """
@@ -1222,7 +1289,7 @@ def delete_directory(
     """
     try:
 
-        if v_true(directory, str, debug=debug) and check_file_type(directory, 'dir', debug=debug):
+        if isinstance(directory, str) and check_file_type(directory, 'dir', debug=debug):
 
             rmtree(directory)
 
@@ -1265,7 +1332,7 @@ def delete_directory(
 
 def process_pool(
     process_func: Callable,
-    process_data: any = None,
+    process_data: Any = None,
     process_num: int = 2,
     thread: bool = False,
     debug: bool = False,
@@ -1289,6 +1356,9 @@ def process_pool(
         else:
             _data = list_split(process_data, process_num, equally=True, debug=debug)
 
+        if _data is None:
+            return False
+
         if v_true(debug, bool):
             logger.info(f"data: {_data}")
 
@@ -1314,7 +1384,7 @@ def process_pool(
 
 def new_process(
     process_func: Callable,
-    process_data: any = None,
+    process_data: Any = None,
     thread: bool = False,
     daemon: bool = True,
     debug: bool = False,
@@ -1409,17 +1479,24 @@ def change_directory(
 ) -> bool:
     """改变目录"""
     try:
-        directory = str(directory) if v_true(directory, str, debug=debug) else next
+
+        if not v_true(directory, str, debug=debug):
+            return False
+
         if v_true(debug, bool):
             logger.info(f"directory: {directory}")
+
         if check_file_type(directory, 'dir', debug=debug):
             if v_true(debug, bool):
                 logger.info(f"change directory to {directory}")
             os.chdir(directory)
             return True
+
         if v_true(debug, bool):
             logger.error(f"no such directory: {directory}")
+
         return False
+
     except Exception as e:
         if v_true(debug, bool):
             logger.exception(e)
@@ -1430,12 +1507,12 @@ def change_directory(
 
 
 def load_toml_file(
-    file: str = None,
+    file: str,
     debug: bool = False
 ) -> dict | None:
     """Load TOML file"""
+    info = '解析配置文件'
     try:
-        info = '解析配置文件'
         if v_true(debug, bool):
             logger.info(f'{info}[执行]')
         with open(file, "rb") as _file:
@@ -1488,15 +1565,23 @@ def git_clone(
             stdout=subprocess.PIPE,
             stderr=subprocess.STDOUT
         )
-        result_code = result.returncode
+
+        if result is None:
+            return False
+
+        result_code: int = result.returncode
         result_info = result.stdout.splitlines()
+
         if v_true(debug, bool):
             logger.error(f'{log_prefix}unsuccessful')
             for i in result_info:
                 logger.error(f'{log_prefix}{i}')
+
         if result_code == 0:
             return True
+
         return False
+
     except Exception as e:
         if v_true(debug, bool):
             logger.error(f'{log_prefix}unsuccessful')

{ezKit-1.7.0.dist-info → ezKit-1.7.1.dist-info}/METADATA

@@ -1,9 +1,9 @@
 Metadata-Version: 2.1
 Name: ezKit
-Version: 1.7.0
+Version: 1.7.1
 Summary: Easy Kit
 Author: septvean
 Author-email: septvean@gmail.com
-Requires-Python: >=3.10
+Requires-Python: >=3.11
 License-File: LICENSE
 

{ezKit-1.7.0.dist-info → ezKit-1.7.1.dist-info}/RECORD

@@ -1,5 +1,5 @@
 ezKit/__init__.py,sha256=v6kh1vyXewSi_0PE0CMXrGz0aME4tISx_7BPXIKtZ9E,70
-ezKit/bottle.py,sha256=iJVdWAfpOi2ksPZlyZtALczPj9aqqcNXrSXSClUCJwc,151993
+ezKit/bottle.py,sha256=0lLLrzgAWhPj47KOdyITIsPRNUFGuwovA3vRW47SpUs,180117
 ezKit/bottle_extensions.py,sha256=OQUwHNg4cbZ0UZXwT6FJjwl4uAg00_Q-Zpogt_xHElk,1088
 ezKit/cipher.py,sha256=SIQ1xDHMHudXSg_5vJ06_wDc6kFldLryezO8t_eaFqg,2845
 ezKit/database.py,sha256=imOeBSU6kCIrVHei485HEROnmsr5UZtCcqwHk0vDzwY,6741
@@ -12,11 +12,11 @@ ezKit/redis.py,sha256=pY4SPlcgQ7S8IeY2xoDpxy-xCZxzZQrQJNAoWRsC1dI,1773
 ezKit/reports.py,sha256=dBBggggCCLuk5YD6SjdUPuxTr3wiJojP3lA7dQfg6Pk,8898
 ezKit/sendemail.py,sha256=PItznLBcZ6Om8NU7rep69m3QNZ9YkmOovup7pPGyY58,4840
 ezKit/token.py,sha256=4L6A26KsxvB4WfF8R7SYiBmihJK0PiN5Oh7dgDVJtxU,1382
-ezKit/utils.py,sha256=5FB6s2SVcmWm3S_u4ADF7U6pjCr1ql4p7XA7xi3pUcg,46748
+ezKit/utils.py,sha256=VkZzKy_jupr25Axa5I0juMsm1XiaimyiPoSITA91jcg,47826
 ezKit/xftp.py,sha256=qbCqFcGe22TDBSisj0Zoz78tnydDWoOfvywWpXdfaGw,6982
 ezKit/zabbix.py,sha256=soM5UEeYMfm7NczbPOVLirmHm3G20dECQ0aCBttZfhQ,28350
-ezKit-1.7.0.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-ezKit-1.7.0.dist-info/METADATA,sha256=TSUVcXe-J1GkYU9A5J29eL4RsXJ-tQiBJkxFYTclpeQ,164
-ezKit-1.7.0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-ezKit-1.7.0.dist-info/top_level.txt,sha256=aYLB_1WODsqNTsTFWcKP-BN0KCTKcV-HZJ4zlHkCFw8,6
-ezKit-1.7.0.dist-info/RECORD,,
+ezKit-1.7.1.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+ezKit-1.7.1.dist-info/METADATA,sha256=KibjySW6aXShA6YkITs9NwhdMG4LCijMTKcAu7-uT50,164
+ezKit-1.7.1.dist-info/WHEEL,sha256=R06PA3UVYHThwHvxuRWMqaGcr-PuniXahwjmQRFMEkY,91
+ezKit-1.7.1.dist-info/top_level.txt,sha256=aYLB_1WODsqNTsTFWcKP-BN0KCTKcV-HZJ4zlHkCFw8,6
+ezKit-1.7.1.dist-info/RECORD,,

{ezKit-1.7.0.dist-info → ezKit-1.7.1.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.43.0)
+Generator: setuptools (75.5.0)
 Root-Is-Purelib: true
 Tag: py3-none-any