funcguard 0.1.3__tar.gz → 0.1.5__tar.gz

{funcguard-0.1.3 → funcguard-0.1.5}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.1
 Name: funcguard
-Version: 0.1.3
-Summary: A funcguard for Python.
+Version: 0.1.5
+Summary: FuncGuard是一个Python库，提供函数执行超时控制、重试机制、HTTP请求封装和格式化打印工具。
 Home-page: https://github.com/tinycen/funcguard
 Author: tinycen
 Author-email: sky_ruocen@qq.com
@@ -22,6 +22,7 @@ FuncGuard是一个Python库，提供了函数执行超时控制和重试机制
 - 函数执行失败自动重试
 - HTTP请求封装（支持自动重试）
 - 格式化打印工具（分隔线和块打印）
+- 时间日志记录和耗时统计
 
 ## 安装/升级
 
@@ -37,7 +38,7 @@ pip install --upgrade funcguard
 使用`timeout_handler`函数可以控制函数的执行时间，防止函数运行时间过长：
 
 ```python
-from funcguard.core import timeout_handler
+from funcguard import timeout_handler
 
 def long_running_function():
     # 模拟一个耗时操作
@@ -58,7 +59,7 @@ except TimeoutError as e:
 使用`retry_function`函数可以在函数执行失败时自动重试：
 
 ```python
-from funcguard.core import retry_function
+from funcguard import retry_function
 
 def unstable_function():
     # 模拟一个可能失败的操作
@@ -80,7 +81,7 @@ except Exception as e:
 使用`send_request`函数发送HTTP请求，支持自动重试：
 
 ```python
-from funcguard.tools import send_request
+from funcguard import send_request
 
 # 不使用重试
 response = send_request(
@@ -112,7 +113,7 @@ print(response)
 使用`print_line`和`print_block`函数进行格式化打印，便于查看和调试：
 
 ```python
-from funcguard.printer import print_line, print_block
+from funcguard import print_line, print_block
 
 # 打印分隔线
 print_line()  # 默认使用40个'-'字符
@@ -133,6 +134,61 @@ result = {
 print_block("API响应", result)
 ```
 
+### 时间日志记录
+
+使用`time_log`和`time_diff`函数记录任务执行时间和统计信息：
+
+```python
+from funcguard import time_log, time_diff
+
+# 获取开始时间
+start_time = time_diff()
+
+# 记录任务开始（i从0开始）
+time_log("开始处理数据", 0, 100, 0, start_time)
+
+# 模拟处理过程
+import time
+for i in range(1, 101):
+    time.sleep(0.1)  # 模拟处理时间
+    if i % 20 == 0:
+        time_log(f"处理进度", i, 100, 0, start_time)  # 显示进度和预计完成时间
+
+# 记录任务完成并打印统计信息
+time_log("数据处理完成", 100, 100, 0, start_time)
+time_diff(start_time, 100, "cn")  # 中文显示统计信息
+```
+
+或者当i从1开始时：
+
+```python
+from funcguard import time_log, time_diff
+
+# 获取开始时间
+start_time = time_diff()
+
+# 记录任务开始（i从1开始）
+time_log("开始处理数据", 1, 100, 1, start_time)
+
+# 模拟处理过程
+import time
+for i in range(1, 101):
+    time.sleep(0.1)  # 模拟处理时间
+    if i % 20 == 0:
+        time_log(f"处理进度", i, 100, 1, start_time)  # 显示进度和预计完成时间
+
+# 记录任务完成并打印统计信息
+time_log("数据处理完成", 100, 100, 1, start_time)
+time_diff(start_time, 100, "cn")  # 中文显示统计信息
+```
+
+时间日志功能特点：
+- 自动显示北京时间（UTC+8）
+- 支持进度显示和预计完成时间计算
+- 提供中英文双语统计信息
+- 可显示总耗时、平均耗时等详细统计
+- 支持i从0或从1开始的计数方式
+
 ## API文档
 
 ### funcguard.core
@@ -174,6 +230,26 @@ print_block("API响应", result)
 - **返回值**: 根据return_type参数返回不同格式的响应数据
 - **异常**: 当请求失败且重试次数用尽后，抛出相应的异常
 
+#### time_log(message, i=0, max_num=0, start_from=0, s_time=None)
+
+- **参数**:
+  - `message`: 日志消息
+  - `i`: 当前进度，默认为0
+  - `max_num`: 总进度数量，默认为0
+  - `start_from`: i是否从0开始，0表示从0开始，1表示从1开始，默认为0
+  - `s_time`: 开始时间，用于计算预计完成时间，默认为None
+- **返回值**: 无
+- **功能**: 打印带时间戳的日志信息，支持进度显示和预计完成时间计算
+
+#### time_diff(s_time=None, max_num=0, language="cn")
+
+- **参数**:
+  - `s_time`: 开始时间，默认为None
+  - `max_num`: 任务数量，默认为0
+  - `language`: 语言选择（"cn"中文，其他为英文），默认为"cn"
+- **返回值**: 如果s_time为None则返回当前时间，否则返回None
+- **功能**: 计算并打印任务执行时间统计信息，支持中英文双语输出
+
 ### funcguard.printer
 
 #### print_line(separator_char: str = "-", separator_length: int = 40) -> None

{funcguard-0.1.3 → funcguard-0.1.5}/README.md

@@ -8,6 +8,7 @@ FuncGuard是一个Python库，提供了函数执行超时控制和重试机制
 - 函数执行失败自动重试
 - HTTP请求封装（支持自动重试）
 - 格式化打印工具（分隔线和块打印）
+- 时间日志记录和耗时统计
 
 ## 安装/升级
 
@@ -23,7 +24,7 @@ pip install --upgrade funcguard
 使用`timeout_handler`函数可以控制函数的执行时间，防止函数运行时间过长：
 
 ```python
-from funcguard.core import timeout_handler
+from funcguard import timeout_handler
 
 def long_running_function():
     # 模拟一个耗时操作
@@ -44,7 +45,7 @@ except TimeoutError as e:
 使用`retry_function`函数可以在函数执行失败时自动重试：
 
 ```python
-from funcguard.core import retry_function
+from funcguard import retry_function
 
 def unstable_function():
     # 模拟一个可能失败的操作
@@ -66,7 +67,7 @@ except Exception as e:
 使用`send_request`函数发送HTTP请求，支持自动重试：
 
 ```python
-from funcguard.tools import send_request
+from funcguard import send_request
 
 # 不使用重试
 response = send_request(
@@ -98,7 +99,7 @@ print(response)
 使用`print_line`和`print_block`函数进行格式化打印，便于查看和调试：
 
 ```python
-from funcguard.printer import print_line, print_block
+from funcguard import print_line, print_block
 
 # 打印分隔线
 print_line()  # 默认使用40个'-'字符
@@ -119,6 +120,61 @@ result = {
 print_block("API响应", result)
 ```
 
+### 时间日志记录
+
+使用`time_log`和`time_diff`函数记录任务执行时间和统计信息：
+
+```python
+from funcguard import time_log, time_diff
+
+# 获取开始时间
+start_time = time_diff()
+
+# 记录任务开始（i从0开始）
+time_log("开始处理数据", 0, 100, 0, start_time)
+
+# 模拟处理过程
+import time
+for i in range(1, 101):
+    time.sleep(0.1)  # 模拟处理时间
+    if i % 20 == 0:
+        time_log(f"处理进度", i, 100, 0, start_time)  # 显示进度和预计完成时间
+
+# 记录任务完成并打印统计信息
+time_log("数据处理完成", 100, 100, 0, start_time)
+time_diff(start_time, 100, "cn")  # 中文显示统计信息
+```
+
+或者当i从1开始时：
+
+```python
+from funcguard import time_log, time_diff
+
+# 获取开始时间
+start_time = time_diff()
+
+# 记录任务开始（i从1开始）
+time_log("开始处理数据", 1, 100, 1, start_time)
+
+# 模拟处理过程
+import time
+for i in range(1, 101):
+    time.sleep(0.1)  # 模拟处理时间
+    if i % 20 == 0:
+        time_log(f"处理进度", i, 100, 1, start_time)  # 显示进度和预计完成时间
+
+# 记录任务完成并打印统计信息
+time_log("数据处理完成", 100, 100, 1, start_time)
+time_diff(start_time, 100, "cn")  # 中文显示统计信息
+```
+
+时间日志功能特点：
+- 自动显示北京时间（UTC+8）
+- 支持进度显示和预计完成时间计算
+- 提供中英文双语统计信息
+- 可显示总耗时、平均耗时等详细统计
+- 支持i从0或从1开始的计数方式
+
 ## API文档
 
 ### funcguard.core
@@ -160,6 +216,26 @@ print_block("API响应", result)
 - **返回值**: 根据return_type参数返回不同格式的响应数据
 - **异常**: 当请求失败且重试次数用尽后，抛出相应的异常
 
+#### time_log(message, i=0, max_num=0, start_from=0, s_time=None)
+
+- **参数**:
+  - `message`: 日志消息
+  - `i`: 当前进度，默认为0
+  - `max_num`: 总进度数量，默认为0
+  - `start_from`: i是否从0开始，0表示从0开始，1表示从1开始，默认为0
+  - `s_time`: 开始时间，用于计算预计完成时间，默认为None
+- **返回值**: 无
+- **功能**: 打印带时间戳的日志信息，支持进度显示和预计完成时间计算
+
+#### time_diff(s_time=None, max_num=0, language="cn")
+
+- **参数**:
+  - `s_time`: 开始时间，默认为None
+  - `max_num`: 任务数量，默认为0
+  - `language`: 语言选择（"cn"中文，其他为英文），默认为"cn"
+- **返回值**: 如果s_time为None则返回当前时间，否则返回None
+- **功能**: 计算并打印任务执行时间统计信息，支持中英文双语输出
+
 ### funcguard.printer
 
 #### print_line(separator_char: str = "-", separator_length: int = 40) -> None

{funcguard-0.1.3 → funcguard-0.1.5}/funcguard/__init__.py

@@ -1,5 +1,5 @@
 from .core import timeout_handler, retry_function
-from .tools import send_request
+from .tools import send_request, time_log, time_diff
 from .printer import print_block, print_line
 
 __author__ = "ruocen"
@@ -9,6 +9,8 @@ __all__ = [
     "timeout_handler",
     "retry_function",
     "send_request",
+    "time_log",
+    "time_diff",
     "print_block",
     "print_line",
 ]

funcguard-0.1.5/funcguard/tools.py

@@ -0,0 +1,148 @@
+import json
+import requests
+from datetime import datetime, timezone, timedelta
+from typing import Optional, Dict, Any, Union
+from .core import retry_function
+
+
+# 发起请求
+def send_request(
+    method: str,
+    url: str,
+    headers: Dict[str, str],
+    data: Optional[Any] = None,
+    return_type: str = "json",
+    timeout: int = 60,
+    auto_retry: Optional[Dict[str, Any]] = None,
+) -> Union[Dict, str, requests.Response]:
+    """
+    发送HTTP请求的通用函数
+
+    :param method: HTTP方法（GET, POST等）
+    :param url: 请求URL
+    :param headers: 请求头
+    :param data: 请求数据
+    :param return_type: 返回类型（json, text, response）
+    :param timeout: 请求超时时间
+    :param auto_retry: 自动重试配置，格式为：
+                     {"task_name": "任务名称", "max_retries": 最大重试次数, "execute_timeout": 执行超时时间}
+    :return: 请求结果
+    """
+    if data is None:
+        payload = {}
+    else:
+        if (isinstance(data, dict) or isinstance(data, list)) and data != {}:
+            payload = json.dumps(data, ensure_ascii=False)
+        else:
+            payload = data
+    if auto_retry is None:
+        response = requests.request(
+            method, url, headers=headers, data=payload, timeout=timeout
+        )
+    else:
+        max_retries = auto_retry.get("max_retries", 5)
+        execute_timeout = auto_retry.get("execute_timeout", 90)
+        task_name = auto_retry.get("task_name", "")
+        response = retry_function(
+            requests.request,
+            max_retries,
+            execute_timeout,
+            task_name,
+            method,
+            url,
+            headers=headers,
+            data=payload,
+            timeout=timeout,
+        )
+
+    if response is None:
+        raise ValueError("请求返回的响应为None")
+
+    if return_type == "json":
+        result = response.json()
+    elif return_type == "response":
+        return response
+    else:
+        result = response.text
+    return result
+
+
+# 打印时间
+def time_log(message, i = 0, max_num = 0, start_from = 0, s_time = None,) :
+    """
+    打印带时间戳的日志信息，支持进度显示和预计完成时间
+    
+    :param message: 日志消息
+    :param i: 当前进度
+    :param max_num: 总进度数量
+    :param start_from: i是否从0开始，0表示从0开始，1表示从1开始
+    :param s_time: 开始时间，用于计算预计完成时间
+    :return: None
+    """
+    now = datetime.now( timezone( timedelta( hours = 8 ) ) )
+    time_log = "{:02d}:{:02d}:{:02d}".format( now.hour, now.minute, now.second )
+    if i < 2 or max_num < 2 :
+        print( time_log + " " + message )
+
+    else :
+        # 根据start_from参数计算实际处理的项目数
+        process_item = i + 1 if start_from == 0 else i
+        text = "{}/{}".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
+            ev_duration = duration / process_item  # 每项平均耗时
+            remaining_items = max_num - process_item
+            time_left = ev_duration * remaining_items
+            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
+
+
+# 计算持续时间
+def time_diff(s_time = None, max_num = 0, language = "cn") :
+    """
+    计算并打印任务执行时间统计信息
+    
+    :param s_time: 开始时间
+    :param max_num: 任务数量
+    :param language: 语言选择（"cn"中文，其他为英文）
+    :return: 如果s_time为None则返回当前时间，否则返回None
+    """
+    # 获取当前时间并转换为北京时间
+    now = datetime.now( timezone( timedelta( hours = 8 ) ) )
+
+    if s_time is None :
+        return now
+
+    e_time = now
+    duration = e_time - s_time
+    hours = duration.seconds // 3600
+    duration_minutes = (duration.seconds % 3600) // 60
+    seconds = duration.seconds % 60
+    result = f"{hours:02d}:{duration_minutes:02d}:{seconds:02d}"
+
+    # 将时间差转化为分钟
+    minutes = round( duration.total_seconds() / 60 )
+    if max_num == 0 :
+        if language == "cn" :
+            print( "总耗时：{}".format( result ) )
+        else :
+            print( "Total time: {}".format( result ) )
+    else :
+        eve_minutes = round( minutes / max_num, 3 )
+        if language == "cn" :
+            print( "开始时间：{}，结束时间：{}".format( s_time.strftime( "%Y-%m-%d %H:%M" ), 
+                                                     e_time.strftime( "%Y-%m-%d %H:%M" ) ) )
+            print( "总耗时：{}，累计：{}分钟，数量；{}，平均耗时：{}分钟".format( result, minutes, max_num, eve_minutes ) )
+        else :
+            print( "Start time：{}，End time：{}".format( s_time.strftime( "%Y-%m-%d %H:%M" ), 
+                                                        e_time.strftime( "%Y-%m-%d %H:%M" ) ) )
+            print( "Total time: {}，Total minutes: {}，Number: {}，Average time: {} minutes".format( result, minutes, 
+                                                                                                   max_num, 
+                                                                                                   eve_minutes ) )
+
+    return

{funcguard-0.1.3 → funcguard-0.1.5}/funcguard.egg-info/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.1
 Name: funcguard
-Version: 0.1.3
-Summary: A funcguard for Python.
+Version: 0.1.5
+Summary: FuncGuard是一个Python库，提供函数执行超时控制、重试机制、HTTP请求封装和格式化打印工具。
 Home-page: https://github.com/tinycen/funcguard
 Author: tinycen
 Author-email: sky_ruocen@qq.com
@@ -22,6 +22,7 @@ FuncGuard是一个Python库，提供了函数执行超时控制和重试机制
 - 函数执行失败自动重试
 - HTTP请求封装（支持自动重试）
 - 格式化打印工具（分隔线和块打印）
+- 时间日志记录和耗时统计
 
 ## 安装/升级
 
@@ -37,7 +38,7 @@ pip install --upgrade funcguard
 使用`timeout_handler`函数可以控制函数的执行时间，防止函数运行时间过长：
 
 ```python
-from funcguard.core import timeout_handler
+from funcguard import timeout_handler
 
 def long_running_function():
     # 模拟一个耗时操作
@@ -58,7 +59,7 @@ except TimeoutError as e:
 使用`retry_function`函数可以在函数执行失败时自动重试：
 
 ```python
-from funcguard.core import retry_function
+from funcguard import retry_function
 
 def unstable_function():
     # 模拟一个可能失败的操作
@@ -80,7 +81,7 @@ except Exception as e:
 使用`send_request`函数发送HTTP请求，支持自动重试：
 
 ```python
-from funcguard.tools import send_request
+from funcguard import send_request
 
 # 不使用重试
 response = send_request(
@@ -112,7 +113,7 @@ print(response)
 使用`print_line`和`print_block`函数进行格式化打印，便于查看和调试：
 
 ```python
-from funcguard.printer import print_line, print_block
+from funcguard import print_line, print_block
 
 # 打印分隔线
 print_line()  # 默认使用40个'-'字符
@@ -133,6 +134,61 @@ result = {
 print_block("API响应", result)
 ```
 
+### 时间日志记录
+
+使用`time_log`和`time_diff`函数记录任务执行时间和统计信息：
+
+```python
+from funcguard import time_log, time_diff
+
+# 获取开始时间
+start_time = time_diff()
+
+# 记录任务开始（i从0开始）
+time_log("开始处理数据", 0, 100, 0, start_time)
+
+# 模拟处理过程
+import time
+for i in range(1, 101):
+    time.sleep(0.1)  # 模拟处理时间
+    if i % 20 == 0:
+        time_log(f"处理进度", i, 100, 0, start_time)  # 显示进度和预计完成时间
+
+# 记录任务完成并打印统计信息
+time_log("数据处理完成", 100, 100, 0, start_time)
+time_diff(start_time, 100, "cn")  # 中文显示统计信息
+```
+
+或者当i从1开始时：
+
+```python
+from funcguard import time_log, time_diff
+
+# 获取开始时间
+start_time = time_diff()
+
+# 记录任务开始（i从1开始）
+time_log("开始处理数据", 1, 100, 1, start_time)
+
+# 模拟处理过程
+import time
+for i in range(1, 101):
+    time.sleep(0.1)  # 模拟处理时间
+    if i % 20 == 0:
+        time_log(f"处理进度", i, 100, 1, start_time)  # 显示进度和预计完成时间
+
+# 记录任务完成并打印统计信息
+time_log("数据处理完成", 100, 100, 1, start_time)
+time_diff(start_time, 100, "cn")  # 中文显示统计信息
+```
+
+时间日志功能特点：
+- 自动显示北京时间（UTC+8）
+- 支持进度显示和预计完成时间计算
+- 提供中英文双语统计信息
+- 可显示总耗时、平均耗时等详细统计
+- 支持i从0或从1开始的计数方式
+
 ## API文档
 
 ### funcguard.core
@@ -174,6 +230,26 @@ print_block("API响应", result)
 - **返回值**: 根据return_type参数返回不同格式的响应数据
 - **异常**: 当请求失败且重试次数用尽后，抛出相应的异常
 
+#### time_log(message, i=0, max_num=0, start_from=0, s_time=None)
+
+- **参数**:
+  - `message`: 日志消息
+  - `i`: 当前进度，默认为0
+  - `max_num`: 总进度数量，默认为0
+  - `start_from`: i是否从0开始，0表示从0开始，1表示从1开始，默认为0
+  - `s_time`: 开始时间，用于计算预计完成时间，默认为None
+- **返回值**: 无
+- **功能**: 打印带时间戳的日志信息，支持进度显示和预计完成时间计算
+
+#### time_diff(s_time=None, max_num=0, language="cn")
+
+- **参数**:
+  - `s_time`: 开始时间，默认为None
+  - `max_num`: 任务数量，默认为0
+  - `language`: 语言选择（"cn"中文，其他为英文），默认为"cn"
+- **返回值**: 如果s_time为None则返回当前时间，否则返回None
+- **功能**: 计算并打印任务执行时间统计信息，支持中英文双语输出
+
 ### funcguard.printer
 
 #### print_line(separator_char: str = "-", separator_length: int = 40) -> None

{funcguard-0.1.3 → funcguard-0.1.5}/setup.py

@@ -9,14 +9,14 @@ except FileNotFoundError:
 
 setup(
     name='funcguard',
-    version='0.1.3',
+    version='0.1.5',
     packages=find_packages(),
     install_requires=[
         'requests',
     ],
     author='tinycen',
     author_email='sky_ruocen@qq.com',
-    description='A funcguard for Python.',
+    description='FuncGuard是一个Python库，提供函数执行超时控制、重试机制、HTTP请求封装和格式化打印工具。',
     long_description=long_description,
     long_description_content_type='text/markdown',
     url='https://github.com/tinycen/funcguard',

funcguard-0.1.3/funcguard/tools.py

@@ -1,66 +0,0 @@
-import json
-import requests
-from typing import Optional, Dict, Any, Union
-from .core import retry_function
-
-
-# 发起请求
-def send_request(
-    method: str,
-    url: str,
-    headers: Dict[str, str],
-    data: Optional[Any] = None,
-    return_type: str = "json",
-    timeout: int = 60,
-    auto_retry: Optional[Dict[str, Any]] = None,
-) -> Union[Dict, str, requests.Response]:
-    """
-    发送HTTP请求的通用函数
-
-    :param method: HTTP方法（GET, POST等）
-    :param url: 请求URL
-    :param headers: 请求头
-    :param data: 请求数据
-    :param return_type: 返回类型（json, text, response）
-    :param timeout: 请求超时时间
-    :param auto_retry: 自动重试配置，格式为：
-                     {"task_name": "任务名称", "max_retries": 最大重试次数, "execute_timeout": 执行超时时间}
-    :return: 请求结果
-    """
-    if data is None:
-        payload = {}
-    else:
-        if (isinstance(data, dict) or isinstance(data, list)) and data != {}:
-            payload = json.dumps(data, ensure_ascii=False)
-        else:
-            payload = data
-    if auto_retry is None:
-        response = requests.request(
-            method, url, headers=headers, data=payload, timeout=timeout
-        )
-    else:
-        max_retries = auto_retry.get("max_retries", 5)
-        execute_timeout = auto_retry.get("execute_timeout", 90)
-        task_name = auto_retry.get("task_name", "")
-        response = retry_function(
-            requests.request,
-            max_retries,
-            execute_timeout,
-            task_name,
-            method,
-            url,
-            headers=headers,
-            data=payload,
-            timeout=timeout,
-        )
-
-    if response is None:
-        raise ValueError("请求返回的响应为None")
-
-    if return_type == "json":
-        result = response.json()
-    elif return_type == "response":
-        return response
-    else:
-        result = response.text
-    return result