funcguard 0.1.1__tar.gz → 0.1.3__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: funcguard
-Version: 0.1.1
+Version: 0.1.3
 Summary: A funcguard for Python.
 Home-page: https://github.com/tinycen/funcguard
 Author: tinycen
@@ -21,13 +21,10 @@ FuncGuard是一个Python库，提供了函数执行超时控制和重试机制
 - 函数执行超时控制
 - 函数执行失败自动重试
 - HTTP请求封装（支持自动重试）
+- 格式化打印工具（分隔线和块打印）
 
 ## 安装/升级
 
-```bash
-pip install funcguard
-```
-
 ```bash
 pip install --upgrade funcguard
 ```
@@ -110,6 +107,32 @@ response = send_request(
 print(response)
 ```
 
+### 格式化打印
+
+使用`print_line`和`print_block`函数进行格式化打印，便于查看和调试：
+
+```python
+from funcguard.printer import print_line, print_block
+
+# 打印分隔线
+print_line()  # 默认使用40个'-'字符
+print_line("*", 30)  # 使用30个'*'字符
+
+# 打印块内容
+print_block("用户信息", {"name": "张三", "age": 25})
+
+# 自定义分隔符
+print_block("配置信息", {"debug": True, "port": 8080}, "=", 50)
+
+# 打印复杂内容
+result = {
+    "status": "success",
+    "data": [1, 2, 3, 4, 5],
+    "message": "操作完成"
+}
+print_block("API响应", result)
+```
+
 ## API文档
 
 ### funcguard.core
@@ -151,6 +174,26 @@ print(response)
 - **返回值**: 根据return_type参数返回不同格式的响应数据
 - **异常**: 当请求失败且重试次数用尽后，抛出相应的异常
 
+### funcguard.printer
+
+#### print_line(separator_char: str = "-", separator_length: int = 40) -> None
+
+- **参数**:
+  - `separator_char`: 分隔符字符，默认为'-'
+  - `separator_length`: 分隔符长度，默认为40
+- **返回值**: 无
+- **功能**: 打印分隔线，用于分隔不同的打印块
+
+#### print_block(title: str, content: Any, separator_char: str = "-", separator_length: int = 40) -> None
+
+- **参数**:
+  - `title`: 标题
+  - `content`: 打印的内容
+  - `separator_char`: 分隔符字符，默认为'-'
+  - `separator_length`: 分隔符长度，默认为40
+- **返回值**: 无
+- **功能**: 使用分隔符打印标题和内容，便于查看
+
 ## 许可证
 
 MIT License

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

@@ -7,13 +7,10 @@ FuncGuard是一个Python库，提供了函数执行超时控制和重试机制
 - 函数执行超时控制
 - 函数执行失败自动重试
 - HTTP请求封装（支持自动重试）
+- 格式化打印工具（分隔线和块打印）
 
 ## 安装/升级
 
-```bash
-pip install funcguard
-```
-
 ```bash
 pip install --upgrade funcguard
 ```
@@ -96,6 +93,32 @@ response = send_request(
 print(response)
 ```
 
+### 格式化打印
+
+使用`print_line`和`print_block`函数进行格式化打印，便于查看和调试：
+
+```python
+from funcguard.printer import print_line, print_block
+
+# 打印分隔线
+print_line()  # 默认使用40个'-'字符
+print_line("*", 30)  # 使用30个'*'字符
+
+# 打印块内容
+print_block("用户信息", {"name": "张三", "age": 25})
+
+# 自定义分隔符
+print_block("配置信息", {"debug": True, "port": 8080}, "=", 50)
+
+# 打印复杂内容
+result = {
+    "status": "success",
+    "data": [1, 2, 3, 4, 5],
+    "message": "操作完成"
+}
+print_block("API响应", result)
+```
+
 ## API文档
 
 ### funcguard.core
@@ -137,6 +160,26 @@ print(response)
 - **返回值**: 根据return_type参数返回不同格式的响应数据
 - **异常**: 当请求失败且重试次数用尽后，抛出相应的异常
 
+### funcguard.printer
+
+#### print_line(separator_char: str = "-", separator_length: int = 40) -> None
+
+- **参数**:
+  - `separator_char`: 分隔符字符，默认为'-'
+  - `separator_length`: 分隔符长度，默认为40
+- **返回值**: 无
+- **功能**: 打印分隔线，用于分隔不同的打印块
+
+#### print_block(title: str, content: Any, separator_char: str = "-", separator_length: int = 40) -> None
+
+- **参数**:
+  - `title`: 标题
+  - `content`: 打印的内容
+  - `separator_char`: 分隔符字符，默认为'-'
+  - `separator_length`: 分隔符长度，默认为40
+- **返回值**: 无
+- **功能**: 使用分隔符打印标题和内容，便于查看
+
 ## 许可证
 
 MIT License

funcguard-0.1.3/funcguard/__init__.py

@@ -0,0 +1,14 @@
+from .core import timeout_handler, retry_function
+from .tools import send_request
+from .printer import print_block, print_line
+
+__author__ = "ruocen"
+
+# 暴露主要接口
+__all__ = [
+    "timeout_handler",
+    "retry_function",
+    "send_request",
+    "print_block",
+    "print_line",
+]

{funcguard-0.1.1 → funcguard-0.1.3}/funcguard/core.py

@@ -1,4 +1,11 @@
 class FuncguardTimeoutError(Exception):
+    """
+    funcguard库专用的超时异常类。
+    
+    为了避免与concurrent.futures.TimeoutError和Python内置TimeoutError的命名冲突，
+    特定义此异常类来明确表示这是funcguard库抛出的函数执行超时异常。
+    这样用户可以清晰地区分异常来源，并进行针对性的异常处理。
+    """
     pass
 
 import time
@@ -55,7 +62,7 @@ def retry_function( func , max_retries = 5 , execute_timeout = 90 , task_name =
             result = timeout_handler( func , args = args , kwargs = kwargs , execution_timeout = current_timeout )
             return result  # 如果调用成功，则返回结果
 
-        except BaseException as e :
+        except Exception as e :
             last_exception = e
             retry_count += 1
             print( e )

funcguard-0.1.3/funcguard/printer.py

@@ -0,0 +1,32 @@
+from typing import Any
+
+# 打印分隔线
+def print_line(separator_char: str = "-", separator_length: int = 40) -> None:
+    """
+    打印分隔线，用于分隔不同的打印块
+
+    :param separator_char: 分隔符字符，默认为'-'
+    :param separator_length: 分隔符长度，默认为40
+    """
+    separator = separator_char * separator_length
+    print(separator)
+
+
+# 块打印
+def print_block(title: str, content: Any, separator_char: str = "-", separator_length: int = 40) -> None:
+    """
+    使用分隔符打印标题和内容，便于查看
+
+    :param title: 标题
+    :param content: 打印的内容
+    :param separator_char: 分隔符字符，默认为'-'
+    :param separator_length: 分隔符长度，默认为40
+    """
+    print_line(separator_char, separator_length)
+
+    if title:
+        print(f"{title} :")
+    print(content)
+
+    print_line(separator_char, separator_length)
+    # print()  # 添加一个空行便于阅读

funcguard-0.1.3/funcguard/tools.py

@@ -0,0 +1,66 @@
+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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: funcguard
-Version: 0.1.1
+Version: 0.1.3
 Summary: A funcguard for Python.
 Home-page: https://github.com/tinycen/funcguard
 Author: tinycen
@@ -21,13 +21,10 @@ FuncGuard是一个Python库，提供了函数执行超时控制和重试机制
 - 函数执行超时控制
 - 函数执行失败自动重试
 - HTTP请求封装（支持自动重试）
+- 格式化打印工具（分隔线和块打印）
 
 ## 安装/升级
 
-```bash
-pip install funcguard
-```
-
 ```bash
 pip install --upgrade funcguard
 ```
@@ -110,6 +107,32 @@ response = send_request(
 print(response)
 ```
 
+### 格式化打印
+
+使用`print_line`和`print_block`函数进行格式化打印，便于查看和调试：
+
+```python
+from funcguard.printer import print_line, print_block
+
+# 打印分隔线
+print_line()  # 默认使用40个'-'字符
+print_line("*", 30)  # 使用30个'*'字符
+
+# 打印块内容
+print_block("用户信息", {"name": "张三", "age": 25})
+
+# 自定义分隔符
+print_block("配置信息", {"debug": True, "port": 8080}, "=", 50)
+
+# 打印复杂内容
+result = {
+    "status": "success",
+    "data": [1, 2, 3, 4, 5],
+    "message": "操作完成"
+}
+print_block("API响应", result)
+```
+
 ## API文档
 
 ### funcguard.core
@@ -151,6 +174,26 @@ print(response)
 - **返回值**: 根据return_type参数返回不同格式的响应数据
 - **异常**: 当请求失败且重试次数用尽后，抛出相应的异常
 
+### funcguard.printer
+
+#### print_line(separator_char: str = "-", separator_length: int = 40) -> None
+
+- **参数**:
+  - `separator_char`: 分隔符字符，默认为'-'
+  - `separator_length`: 分隔符长度，默认为40
+- **返回值**: 无
+- **功能**: 打印分隔线，用于分隔不同的打印块
+
+#### print_block(title: str, content: Any, separator_char: str = "-", separator_length: int = 40) -> None
+
+- **参数**:
+  - `title`: 标题
+  - `content`: 打印的内容
+  - `separator_char`: 分隔符字符，默认为'-'
+  - `separator_length`: 分隔符长度，默认为40
+- **返回值**: 无
+- **功能**: 使用分隔符打印标题和内容，便于查看
+
 ## 许可证
 
 MIT License

{funcguard-0.1.1 → funcguard-0.1.3}/funcguard.egg-info/SOURCES.txt

@@ -3,6 +3,7 @@ README.md
 setup.py
 funcguard/__init__.py
 funcguard/core.py
+funcguard/printer.py
 funcguard/tools.py
 funcguard.egg-info/PKG-INFO
 funcguard.egg-info/SOURCES.txt

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

@@ -9,7 +9,7 @@ except FileNotFoundError:
 
 setup(
     name='funcguard',
-    version='0.1.1',
+    version='0.1.3',
     packages=find_packages(),
     install_requires=[
         'requests',

{funcguard-0.1.1 → funcguard-0.1.3}/tests/test_tools.py

@@ -1,6 +1,7 @@
 import json
 import unittest
 from unittest.mock import patch, MagicMock
+from typing import Any, Optional, Dict
 import requests
 
 from funcguard.tools import send_request
@@ -9,12 +10,16 @@ from funcguard.tools import send_request
 class MockResponse:
     """模拟requests响应"""
     
-    def __init__(self, json_data=None, text="", status_code=200):
+    json_data: Dict[str, Any]
+    text: str
+    status_code: int
+    
+    def __init__(self, json_data: Optional[Dict[str, Any]] = None, text: str = "", status_code: int = 200):
         self.json_data = json_data or {}
         self.text = text
         self.status_code = status_code
     
-    def json(self):
+    def json(self) -> Dict[str, Any]:
         return self.json_data
 
 
@@ -97,7 +102,7 @@ class TestSendRequest(unittest.TestCase):
         
         mock_request.assert_called_once()
     
-    @patch('funcguard.core.retry_function')
+    @patch('funcguard.tools.retry_function')
     @patch('requests.request')
     def test_auto_retry_enabled(self, mock_request, mock_retry):
         """测试启用自动重试"""
@@ -117,12 +122,16 @@ class TestSendRequest(unittest.TestCase):
             }
         )
         
-        # 验证结果
-        if hasattr(result, 'json_data'):
-            # 如果result是MockResponse对象，直接比较其json_data
-            self.assertEqual(result.json_data, {"success": True})
+        # 验证结果 - 使用更安全的方式处理可能的类型差异
+        if isinstance(result, dict):
+            # 如果result是字典（JSON解析结果）
+            self.assertEqual(result, {"success": True})
+        elif hasattr(result, 'json_data'):
+            # 如果result是MockResponse对象，使用getattr避免类型检查错误
+            json_data = getattr(result, 'json_data')
+            self.assertEqual(json_data, {"success": True})
         else:
-            # 否则直接比较result
+            # 其他情况，直接比较
             self.assertEqual(result, {"success": True})
         mock_retry.assert_called_once()
     

funcguard-0.1.1/funcguard/__init__.py

@@ -1,7 +0,0 @@
-from .core import timeout_handler, retry_function
-from .tools import send_request
-
-__author__ = "ruocen"
-
-# 暴露主要接口
-__all__ = ["timeout_handler", "retry_function","send_request"]

funcguard-0.1.1/funcguard/tools.py

@@ -1,46 +0,0 @@
-import json
-import requests
-from . import core
-# 使用 from .core import retry_function 会导致测试失败
-
-# 发起请求
-def send_request( method , url , headers , data = None , return_type = "json" , timeout = 60 , auto_retry = None ) :
-    '''
-    发送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 = core.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