feat: add get_file_hash function

README.md

@@ -13,9 +13,9 @@ Support .json, .yaml, .ini files.
 Support auto reloading while config file changes.
 
 ```python
-config_json = Config(os.path.abspath("config.json"))
-config_yaml = Config(os.path.abspath("config.yaml"))
-config_ini = Config(os.path.abspath("config.ini"))
+config_json = Config("configs/config.json")
+config_yaml = Config("configs/config.yaml")
+config_ini = Config("configs/config.ini")
 
 print(config_ini["app"]["config_a"])
 print(config_yaml["movie"]["name"])
@@ -30,7 +30,7 @@ logger = Logger(name="my-logger", level=logging.INFO)
 
 logger.debug("debug log")
 logger.info("info log")
-logger.warn("warn log")
+logger.warning("warning log")
 logger.error("error log")
 ```
 
@@ -74,3 +74,10 @@ Webhook group robot
 robot = GroupRobot(webhook="your robot's webhook path")
 robot.send(data)
 ```
+
+## hash
+
+```python
+from yuanfen import hash
+get_file_hash("path/to/file")
+```

pyproject.toml

@@ -18,9 +18,6 @@ classifiers = [
 ]
 packages = [{ include = "yuanfen", from = "src" }]
 
-[tool.poetry.urls]
-Homepage = "https://github.com/YuanfenNet/yf-lib-py"
-
 [tool.poetry.dependencies]
 python = "^3.9"
 chardet = "^5.2.0"

src/yuanfen/__init__.py

@@ -1,4 +1,4 @@
-from . import ip, time
+from . import hash, ip, time
 from .config import Config
 from .email import Email
 from .env import APP_ENV
@@ -20,6 +20,7 @@
     "RedisLock",
     "SuccessResponse",
     "Version",
+    "hash",
     "ip",
     "time",
 ]

src/yuanfen/hash.py

@@ -0,0 +1,11 @@
+import hashlib
+
+
+def get_file_hash(file_path, algorithm="sha256", chunk_size=8192, length=None):
+    hash_obj = hashlib.new(algorithm)
+    with open(file_path, "rb") as f:
+        while chunk := f.read(chunk_size):
+            hash_obj.update(chunk)
+    if length:
+        return hash_obj.hexdigest()[:length]
+    return hash_obj.hexdigest()