ph-utils 0.1.2__tar.gz → 0.2.2__tar.gz

{ph_utils-0.1.2 → ph_utils-0.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: ph-utils
-Version: 0.1.2
+Version: 0.2.2
 Summary: The python3 tool classes
 Author: Tenny
 Author-email: Tenny <tenny.shu@foxmail.com>
@@ -36,3 +36,9 @@ pip install ph-utils
 ### 5. [config](https://gitee.com/towardly/ph-utils_py/wikis/config_en): Configure relevant tool classes
 
 ### 6. [id](https://gitee.com/towardly/ph-utils_py/wikis/id): 生成唯一 ID 工具类
+
+## 运行测试
+
+```shell
+uv run python tests/crypto_utils.py
+```

{ph_utils-0.1.2 → ph_utils-0.2.2}/README.md

@@ -21,3 +21,9 @@ pip install ph-utils
 ### 5. [config](https://gitee.com/towardly/ph-utils_py/wikis/config_en): Configure relevant tool classes
 
 ### 6. [id](https://gitee.com/towardly/ph-utils_py/wikis/id): 生成唯一 ID 工具类
+
+## 运行测试
+
+```shell
+uv run python tests/crypto_utils.py
+```

{ph_utils-0.1.2 → ph_utils-0.2.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "ph-utils"
-version = "0.1.2"
+version = "0.2.2"
 description = "The python3 tool classes"
 authors = [
     { name = "Tenny", email = "tenny.shu@foxmail.com" },
@@ -30,4 +30,5 @@ build-backend = "uv_build"
 [dependency-groups]
 dev = [
     "ruff>=0.14.10",
+    "pytest>=8.0",
 ]

{ph_utils-0.1.2 → ph_utils-0.2.2}/src/ph_utils/crypto.py

@@ -1,72 +1,73 @@
-# Copyright (c) [2023] [Tenny]
-# [ph-utils] is licensed under Mulan PSL v2.
-# You can use this software according to the terms and conditions of the Mulan PSL v2.
-# You may obtain a copy of Mulan PSL v2 at:
-#         http://license.coscl.org.cn/MulanPSL2
-# THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
-# See the Mulan PSL v2 for more details.
-import hashlib
-import base64
-
-
-def hash(d: str, method="sha1", upper=False, result="hex"):
-    """进行 md5、sha1、sha256 数据摘要签名
-
-    Args:
-        d (str): 待加密的数据
-        method (str, optional): 签名算法, md5、sha1、sha256. Defaults to "md5".
-        upper (bool, optional): 返回的结果是否需要大写. Defaults to False.
-        result (str, optional): 返回数据, hex 转换为 HEX 返回
-
-    Raises:
-        Exception: method只允许为 md5、sha1中的一个
-
-    Returns:
-        str: 加密后的结果
-    """
-    if method in ("md5", "sha1", "sha256"):
-        func = getattr(hashlib, method)
-        althorithm = func()
-        althorithm.update(d.encode("utf-8"))
-        if result == "hex":
-            rd = althorithm.hexdigest()
-            return rd if upper is False else rd.upper()
-        else:
-            return althorithm.digest()
-    else:
-        raise Exception("unsupport_althorithm_method")
-
-
-def b64encode(data, result="str"):
-    """base64加密
-
-    Args:
-        data (str): 待base64加密数据
-        result (str, optional): 加密返回结果, str、bytes. Defaults to "str".
-
-    Returns:
-        str|bytes: base64加密后的数据
-    """
-    if not data:
-        return None
-    encode_data = data
-    if isinstance(encode_data, str):
-        encode_data = encode_data.encode()
-    encoded = base64.b64encode(encode_data)
-    return encoded.decode() if result == "str" else encoded
-
-
-def b64decode(data, result="str"):
-    """base64解密
-
-    Args:
-        data (str|bytes): base64加密后的数据
-        result (str, optional): str、bytes. Defaults to "str".
-
-    Returns:
-        str|bytes: base64解密后的数据
-    """
-    if not data:
-        return None
-    decoded = base64.b64decode(data)
-    return decoded.decode() if result == "str" else decoded
+# Copyright (c) [2023] [Tenny]
+# [ph-utils] is licensed under Mulan PSL v2.
+# You can use this software according to the terms and conditions of the Mulan PSL v2.
+# You may obtain a copy of Mulan PSL v2 at:
+#         http://license.coscl.org.cn/MulanPSL2
+# THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
+# See the Mulan PSL v2 for more details.
+import base64
+import hashlib
+
+
+def hash(d: str, method="sha1", upper=False, result="hex"):
+    """使用 hashlib 支持的算法进行数据摘要签名
+
+    Args:
+        d (str): 待加密的数据
+        method (str, optional): 签名算法, 如 md5、sha1、sha256、sha512 等 hashlib 支持的算法. Defaults to "sha1".
+        upper (bool, optional): 返回的结果是否需要大写. Defaults to False.
+        result (str, optional): 返回数据, hex 转换为 HEX 返回
+
+    Raises:
+        ValueError: 不支持的签名算法
+
+    Returns:
+        str: 加密后的结果
+    """
+    if not hasattr(hashlib, method):
+        raise ValueError(
+            f"不支持的签名算法: {method}, 可用算法: {', '.join(hashlib.algorithms_guaranteed)}"
+        )
+    func = getattr(hashlib, method)
+    althorithm = func()
+    althorithm.update(d.encode("utf-8"))
+    if result == "hex":
+        rd = althorithm.hexdigest()
+        return rd if upper is False else rd.upper()
+    else:
+        return althorithm.digest()
+
+
+def b64encode(data, result="str"):
+    """base64加密
+
+    Args:
+        data (str): 待base64加密数据
+        result (str, optional): 加密返回结果, str、bytes. Defaults to "str".
+
+    Returns:
+        str|bytes: base64加密后的数据
+    """
+    if not data:
+        return None
+    encode_data = data
+    if isinstance(encode_data, str):
+        encode_data = encode_data.encode()
+    encoded = base64.b64encode(encode_data)
+    return encoded.decode() if result == "str" else encoded
+
+
+def b64decode(data, result="str"):
+    """base64解密
+
+    Args:
+        data (str|bytes): base64加密后的数据
+        result (str, optional): str、bytes. Defaults to "str".
+
+    Returns:
+        str|bytes: base64解密后的数据
+    """
+    if not data:
+        return None
+    decoded = base64.b64decode(data)
+    return decoded.decode() if result == "str" else decoded

{ph_utils-0.1.2 → ph_utils-0.2.2}/src/ph_utils/date.py

@@ -246,51 +246,125 @@ def _plus_year(ori_date: datetime, year: int) -> datetime:
     return ori_date.replace(year=new_year)
 
 
-def add(ori_date: OriDateType = None, delta: DeltaDict | None = None) -> datetime:
+def add(
+    ori_date: OriDateType = None,
+    *,
+    days: int | float = 0,
+    months: int = 0,
+    years: int = 0,
+    weeks: int | float = 0,
+    hours: int | float = 0,
+    minutes: int | float = 0,
+    seconds: int | float = 0,
+    microseconds: int | float = 0,
+    milliseconds: int | float = 0,
+) -> datetime:
     """将日期进行加法操作, 通常用于计算几天、几月、几年之后的日期
 
     Args:
         ori_date (datetime | str, optional): 待添加的日期. Defaults to None.
-        delta (dict, optional): { days - 天, months - 月, years - 年, hours - 小时, minutes - 分钟, seconds - 秒 }. Defaults to None.
+        days (int | float, optional): 天数. Defaults to 0.
+        months (int, optional): 月数. Defaults to 0.
+        years (int, optional): 年数. Defaults to 0.
+        weeks (int | float, optional): 周数. Defaults to 0.
+        hours (int | float, optional): 小时数. Defaults to 0.
+        minutes (int | float, optional): 分钟数. Defaults to 0.
+        seconds (int | float, optional): 秒数. Defaults to 0.
+        microseconds (int | float, optional): 微秒数. Defaults to 0.
+        milliseconds (int | float, optional): 毫秒数. Defaults to 0.
 
     Returns:
         datetime: 添加后的日期
     """
-    if not delta:
-        delta = {"days": 0}
     ori_date = parse(ori_date)
-    if "years" in delta:  # 年份
-        ori_date = _plus_year(ori_date, delta["years"])
-        del delta["years"]
-    if "months" in delta:  # 月份
-        ori_date = _plus_month(ori_date, delta["months"])
-        del delta["months"]
-    if delta:
-        diff = timedelta(**delta)
-        ori_date = ori_date + diff
+    if years:
+        ori_date = _plus_year(ori_date, years)
+    if months:
+        ori_date = _plus_month(ori_date, months)
+
+    diff = timedelta(
+        days=days,
+        weeks=weeks,
+        hours=hours,
+        minutes=minutes,
+        seconds=seconds,
+        microseconds=microseconds,
+        milliseconds=milliseconds,
+    )
+    ori_date = ori_date + diff
     return ori_date
 
 
-def subtract(ori_date: OriDateType = None, delta: DeltaDict | None = None):
-    """将日期进行加法操作, 通常用于计算几天、几月、几年之前的日期
+def subtract(
+    ori_date: OriDateType = None,
+    *,
+    days: int | float = 0,
+    months: int = 0,
+    years: int = 0,
+    weeks: int | float = 0,
+    hours: int | float = 0,
+    minutes: int | float = 0,
+    seconds: int | float = 0,
+    microseconds: int | float = 0,
+    milliseconds: int | float = 0,
+):
+    """将日期进行减法操作, 通常用于计算几天、几月、几年之前的日期
 
     Args:
         ori_date (datetime | str, optional): 原始日期. Defaults to None.
-        delta (dict, optional): { days - 天, months - 月, years - 年 }. Defaults to None.
+        days (int | float, optional): 天数. Defaults to 0.
+        months (int, optional): 月数. Defaults to 0.
+        years (int, optional): 年数. Defaults to 0.
+        weeks (int | float, optional): 周数. Defaults to 0.
+        hours (int | float, optional): 小时数. Defaults to 0.
+        minutes (int | float, optional): 分钟数. Defaults to 0.
+        seconds (int | float, optional): 秒数. Defaults to 0.
+        microseconds (int | float, optional): 微秒数. Defaults to 0.
+        milliseconds (int | float, optional): 毫秒数. Defaults to 0.
 
     Returns:
-        datetime: 添加后的日期
+        datetime: 减去之后的日期
     """
-    if not delta:
-        delta = {"days": 0}
-    for key in delta:
-        delta[key] = -delta[key]
-    return add(ori_date, delta)
-
-
-def sub(ori_date: OriDateType = None, delta: DeltaDict | None = None):
+    return add(
+        ori_date,
+        days=-days,
+        months=-months,
+        years=-years,
+        weeks=-weeks,
+        hours=-hours,
+        minutes=-minutes,
+        seconds=-seconds,
+        microseconds=-microseconds,
+        milliseconds=-milliseconds,
+    )
+
+
+def sub(
+    ori_date: OriDateType = None,
+    *,
+    days: int | float = 0,
+    months: int = 0,
+    years: int = 0,
+    weeks: int | float = 0,
+    hours: int | float = 0,
+    minutes: int | float = 0,
+    seconds: int | float = 0,
+    microseconds: int | float = 0,
+    milliseconds: int | float = 0,
+):
     """subtract 函数别名"""
-    return subtract(ori_date, delta)
+    return subtract(
+        ori_date,
+        days=days,
+        months=months,
+        years=years,
+        weeks=weeks,
+        hours=hours,
+        minutes=minutes,
+        seconds=seconds,
+        microseconds=microseconds,
+        milliseconds=milliseconds,
+    )
 
 
 @overload