funcguard 0.1.8__py3-none-any.whl → 0.2.0__py3-none-any.whl

funcguard/__init__.py

@@ -1,7 +1,7 @@
 from .core import timeout_handler, retry_function
 from .tools import send_request
-from .time_utils import time_log, time_diff, monitor_execution_time
-from .printer import print_block, print_line, print_title
+from .time_utils import time_log, time_diff, time_monitor
+from .printer import print_block, print_line, print_title, print_progress
 
 __author__ = "ruocen"
 
@@ -12,8 +12,9 @@ __all__ = [
     "send_request",
     "time_log",
     "time_diff",
-    "monitor_execution_time",
+    "time_monitor",
     "print_block",
     "print_line",
     "print_title",
+    "print_progress",
 ]

funcguard/printer.py

@@ -1,5 +1,32 @@
 from typing import Any
 
+# 打印进度条
+def print_progress(idx: int, total: int, message: str = "") -> None:
+    """
+    打印进度条，显示当前进度
+    
+    设计原理：
+    - 进度条总长度固定为50个字符，这是终端显示的最佳长度
+    - 使用整除2(//2)将0-100%映射到0-50字符，确保平滑过渡
+    - 已完成部分用'█'表示，未完成部分用'-'表示
+    
+    :param idx: 当前索引（从0开始）
+    :param total: 总数量
+    :param message: 额外消息，默认为空字符串
+    """
+    # 计算当前进度百分比（0-100）
+    percent = int(idx / total * 100)
+    
+    # 构建进度条：
+    bar = '█' * (percent // 2) + '-' * (50 - percent // 2)
+    
+    # 打印进度条：
+    # - \r：回车符，回到行首覆盖之前的内容
+    # - end=''：不换行，保持在同一行更新
+    # - flush=True：立即刷新输出，确保实时显示
+    print(f"\r进度: |{bar}| {percent}% ({idx}/{total}) {message}", end='', flush=True)
+
+
 # 打印带等号的标题（如：=== 初始化分类器 ===）
 def print_title(title: str, separator_char: str = "=", padding_length: int = 3) -> None:
     """

funcguard/time_utils.py

@@ -2,11 +2,10 @@
 时间工具模块，提供时间计算、日志记录和执行时间监控功能
 """
 from datetime import datetime, timezone, timedelta
-from typing import Optional, Union
 
 
 # 打印时间
-def time_log(message, i = 0, max_num = 0, s_time = None, start_from = 0 ) :
+def time_log(message, i = 0, max_num = 0, s_time = None, start_from = 0 , return_field = "progress_info") :
     """
     打印带时间戳的日志信息，支持进度显示和预计完成时间
     
@@ -15,17 +14,20 @@ def time_log(message, i = 0, max_num = 0, s_time = None, start_from = 0 ) :
     :param max_num: 总进度数量
     :param s_time: 开始时间，用于计算预计完成时间
     :param start_from: i是否从0开始，0表示从0开始，1表示从1开始
-    :return: None
+    :param return_field: 返回字段，支持以下：
+        "progress_info" 表示完整进度信息，"remaining_time" 表示剩余时间，"end_time" 表示预计完成时间
+    :return: 根据 return_field 参数返回不同的信息
     """
     now = datetime.now( timezone( timedelta( hours = 8 ) ) )
-    time_log = "{:02d}:{:02d}:{:02d}".format( now.hour, now.minute, now.second )
+    time_str = "{:02d}:{:02d}:{:02d}".format( now.hour, now.minute, now.second )
+    progress_info = ""
     if i < 2 or max_num < 2 :
-        print( time_log + " " + message )
+        print( time_str + " " + message )
 
     else :
         # 根据start_from参数计算实际处理的项目数
         process_item = i + 1 if start_from == 0 else i
-        text = "{}/{}".format( process_item, max_num )
+        progress_info = "{}/{}".format( process_item, max_num )
         # 检查是否应该显示预计完成时间和剩余时间
         if process_item % 10 == 0 and s_time is not None and process_item < max_num :
             duration = now - s_time
@@ -35,9 +37,19 @@ def time_log(message, i = 0, max_num = 0, s_time = None, start_from = 0 ) :
             end_time = now + time_left
             end_time_str = end_time.strftime( "%Y-%m-%d %H:%M" )
             remaining_time_str = str( timedelta( seconds = int( time_left.total_seconds() ) ) )
-            text = text + "（{}）etr {}".format( end_time_str, remaining_time_str )
-        print( time_log + " " + message + " " + text )
-    return
+
+            #  Estimated Time of Arrival（预计完成/到达时间）
+            if return_field == "end_time" :
+                return f"eta {end_time_str}"   
+
+            # Estimated Time Remaining（预计剩余时间）
+            elif return_field == "remaining_time" :
+                return f"etr {remaining_time_str}" 
+
+            progress_info = progress_info + "（{}）etr {}".format( end_time_str, remaining_time_str )
+
+        print( time_str + " " + message + " " + progress_info )
+    return progress_info
 
 
 # 计算持续时间
@@ -97,7 +109,7 @@ def time_diff(s_time = None, max_num = 0, language = "cn", return_duration = 1)
 
 
 # 监控程序的执行时间
-def monitor_execution_time(warning_threshold=None, print_mode=2, func=None, *args, **kwargs):
+def time_monitor(warning_threshold=None, print_mode=2, func=None, *args, **kwargs):
     """
     监控函数执行时间，并返回函数的执行结果和执行时间
     

funcguard/tools.py

@@ -1,9 +1,7 @@
 import json
 import requests
-from datetime import datetime, timezone, timedelta
 from typing import Optional, Dict, Any, Union
 from .core import retry_function
-from .time_utils import time_log, time_diff, monitor_execution_time
 
 
 # 发起请求

{funcguard-0.1.8.dist-info → funcguard-0.2.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: funcguard
-Version: 0.1.8
+Version: 0.2.0
 Summary: FuncGuard是一个Python库，提供函数执行超时控制、重试机制、HTTP请求封装和格式化打印工具。
 Home-page: https://github.com/tinycen/funcguard
 Author: tinycen
@@ -182,10 +182,10 @@ for i in range(1, 101):
 
 ### 执行时间监控
 
-使用`monitor_execution_time`函数监控函数执行时间：
+使用`time_monitor`函数监控函数执行时间：
 
 ```python
-from funcguard import monitor_execution_time
+from funcguard import time_monitor
 
 def some_function():
     # 模拟一个耗时操作
@@ -194,14 +194,14 @@ def some_function():
     return "操作完成"
 
 # 模式1：总是打印执行时间
-result = monitor_execution_time(
+result = time_monitor(
     func=some_function,
     print_mode=1
 )
 print(f"结果: {result}")
 
 # 模式2：仅在超过阈值时打印警告
-result = monitor_execution_time(
+result = time_monitor(
     func=some_function,
     warning_threshold=1.5,  # 设置1.5秒的警告阈值
     print_mode=2
@@ -209,7 +209,7 @@ result = monitor_execution_time(
 print(f"结果: {result}")
 
 # 模式0：不打印任何信息，仅返回结果和执行时间
-result, duration = monitor_execution_time(
+result, duration = time_monitor(
     func=some_function,
     print_mode=0
 )
@@ -294,7 +294,7 @@ print(f"结果: {result}, 耗时: {duration}秒")
   - 否则返回None
 - **功能**: 计算并打印任务执行时间统计信息，支持中英文双语输出
 
-#### monitor_execution_time(warning_threshold=None, print_mode=2, func=None, *args, **kwargs)
+#### time_monitor(warning_threshold=None, print_mode=2, func=None, *args, **kwargs)
 
 - **参数**:
   - `warning_threshold`: 警告阈值（秒），如果执行耗时超过此值则打印警告，默认为None

funcguard-0.2.0.dist-info/RECORD

@@ -0,0 +1,11 @@
+funcguard/__init__.py,sha256=XdbsQ5p2wG9YK9CoI7xWc6UEzFuuOuR_r2dov6D_oiE,469
+funcguard/core.py,sha256=-rFRkE-udxM0wxlcv9Qi_yIQBRdVrGgwza-LYQsVRLg,3632
+funcguard/printer.py,sha256=zjCPPkBrz_D1z8563Vi-raxEti5kLSwahSoqYuP20eg,2455
+funcguard/time_utils.py,sha256=XVk95wxyfwnAAacGpbomoRGznGzpRVwMiSMs5L-ncJU,6758
+funcguard/tools.py,sha256=pw6QCi8BAOTkHKhG3sxqfU3pYzST08YjxTiPvK-SWnU,1972
+tests/__init__.py,sha256=VW6FdWdSC_PL3zEtpkRQfUMf6yVD2OfwtSds82jawTs,26
+funcguard-0.2.0.dist-info/LICENSE,sha256=jgOquECfjiXp5xXQ2zuzItDr4XDBLan-bIzIXl1lS4Y,1064
+funcguard-0.2.0.dist-info/METADATA,sha256=KkUoSZ7dYfAoVKIPFJSpsMB8Vqzej6LZTHB_i8IiefQ,10598
+funcguard-0.2.0.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
+funcguard-0.2.0.dist-info/top_level.txt,sha256=7wL9mWT062DttKNO7Wi1wYWTZilR2AOPRO0rE3gvtB4,16
+funcguard-0.2.0.dist-info/RECORD,,

funcguard-0.1.8.dist-info/RECORD

@@ -1,11 +0,0 @@
-funcguard/__init__.py,sha256=irZLaE4wDu4bRilk0ySHy7ZTZD0-CGWaogrC7MCKM3k,451
-funcguard/core.py,sha256=-rFRkE-udxM0wxlcv9Qi_yIQBRdVrGgwza-LYQsVRLg,3632
-funcguard/printer.py,sha256=Iig_UO4h5LcL0BqCEEdxiu32h4rUq9GJbmf1pC_hd7o,1462
-funcguard/time_utils.py,sha256=be7l6vMivWAfmLP4V91z9jRUYfnn-T4XrCU21eQkXeo,6139
-funcguard/tools.py,sha256=J25wE1JCRqfDnJn7NJGaS9nepATPxNJT4ko4ITkghQA,2091
-tests/__init__.py,sha256=VW6FdWdSC_PL3zEtpkRQfUMf6yVD2OfwtSds82jawTs,26
-funcguard-0.1.8.dist-info/LICENSE,sha256=jgOquECfjiXp5xXQ2zuzItDr4XDBLan-bIzIXl1lS4Y,1064
-funcguard-0.1.8.dist-info/METADATA,sha256=l7J2kuqmcjPUPnyCDt10leuNvwGJpLrSiMSM3sbxzZc,10658
-funcguard-0.1.8.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
-funcguard-0.1.8.dist-info/top_level.txt,sha256=7wL9mWT062DttKNO7Wi1wYWTZilR2AOPRO0rE3gvtB4,16
-funcguard-0.1.8.dist-info/RECORD,,