gohumanloop 0.0.10__py3-none-any.whl → 0.0.11__py3-none-any.whl

gohumanloop/adapters/base_adapter.py

@@ -19,7 +19,7 @@ from inspect import iscoroutinefunction
 from contextlib import asynccontextmanager, contextmanager
 import logging
 
-from gohumanloop.utils import run_async_safely
+from gohumanloop.utils import run_async_safely, generate_function_summary
 from gohumanloop.core.interface import (
     HumanLoopRequest,
     HumanLoopResult,
@@ -241,6 +241,12 @@ class HumanloopAdapter:
 
         @wraps(fn)
         async def async_wrapper(*args: Any, **kwargs: Any) -> R:
+            # Check if ret_key exists in function parameters
+            if ret_key not in fn.__code__.co_varnames:
+                raise ValueError(
+                    f"Function {fn.__name__} must have parameter named {ret_key}"
+                )
+
             # Determine if callback is instance or factory function
             cb = None
             if callable(callback) and not isinstance(callback, HumanLoopCallback):
@@ -255,7 +261,8 @@ class HumanloopAdapter:
                 conversation_id=conversation_id,
                 loop_type=HumanLoopType.APPROVAL,
                 context={
-                    "message": {
+                    "message": generate_function_summary(fn, args, kwargs),
+                    "function": {
                         "function_name": fn.__name__,
                         "function_signature": str(fn.__code__.co_varnames),
                         "arguments": str(args),
@@ -289,7 +296,9 @@ class HumanloopAdapter:
                     "error": result.error,
                 }
 
-            kwargs[ret_key] = approval_info
+                # Inject approval info into kwargs
+                kwargs[ret_key] = approval_info
+
             # Check approval result
             if isinstance(result, HumanLoopResult):
                 # Handle based on approval status
@@ -426,6 +435,12 @@ class HumanloopAdapter:
 
         @wraps(fn)
         async def async_wrapper(*args: Any, **kwargs: Any) -> R:
+            # Check if ret_key exists in function parameters
+            if ret_key not in fn.__code__.co_varnames:
+                raise ValueError(
+                    f"Function {fn.__name__} must have parameter named {ret_key}"
+                )
+
             # Determine if callback is instance or factory function
             cb = None
             state = args[0] if args else None
@@ -516,8 +531,8 @@ class HumanloopAdapter:
                     "responded_at": result.responded_at,
                     "error": result.error,
                 }
-
-            kwargs[ret_key] = conversation_info
+                # Inject conversation info into kwargs
+                kwargs[ret_key] = conversation_info
 
             if isinstance(result, HumanLoopResult):
                 if iscoroutinefunction(fn):
@@ -631,6 +646,12 @@ class HumanloopAdapter:
 
         @wraps(fn)
         async def async_wrapper(*args: Any, **kwargs: Any) -> R:
+            # Check if ret_key exists in function parameters
+            if ret_key not in fn.__code__.co_varnames:
+                raise ValueError(
+                    f"Function {fn.__name__} must have parameter named {ret_key}"
+                )
+
             # Determine if callback is an instance or factory function
             # callback: can be HumanLoopCallback instance or factory function
             # - If factory function: accepts state parameter and returns HumanLoopCallback instance
@@ -665,12 +686,11 @@ class HumanloopAdapter:
                 provider_id=provider_id,
                 blocking=True,
             )
-
-            # 初始化审批结果对象为None
+            # Initialize response info object as None
             resp_info = None
 
             if isinstance(result, HumanLoopResult):
-                # 如果结果是HumanLoopResult类型，则构建完整的审批信息
+                # If result is HumanLoopResult type, build complete response info
                 resp_info = {
                     "conversation_id": result.conversation_id,
                     "request_id": result.request_id,
@@ -682,12 +702,12 @@ class HumanloopAdapter:
                     "responded_at": result.responded_at,
                     "error": result.error,
                 }
+                # Inject approval info into kwargs
+                kwargs[ret_key] = resp_info
 
-            kwargs[ret_key] = resp_info
-
-            # 检查结果是否有效
+            # Check if result is valid
             if isinstance(result, HumanLoopResult):
-                # 返回获取信息结果，由用户去判断是否使用
+                # Return the information result, let user decide whether to use it
                 if iscoroutinefunction(fn):
                     ret = await fn(*args, **kwargs)
                 else:
@@ -701,7 +721,7 @@ class HumanloopAdapter:
             ret = run_async_safely(async_wrapper(*args, **kwargs))
             return cast(R, ret)
 
-        # 根据被装饰函数类型返回对应的wrapper
+        # Return corresponding wrapper based on decorated function type
         if iscoroutinefunction(fn):
             return async_wrapper
         return sync_wrapper

gohumanloop/utils/__init__.py

@@ -1,7 +1,5 @@
 from .utils import run_async_safely, get_secret_from_env
+from .context_formatter import generate_function_summary
 
 
-__all__ = [
-    "run_async_safely",
-    "get_secret_from_env",
-]
+__all__ = ["run_async_safely", "get_secret_from_env", "generate_function_summary"]

gohumanloop/utils/context_formatter.py

@@ -1,64 +1,136 @@
-from typing import Dict, Any
-import json
-
-
-class ContextFormatter:
-    """上下文格式化工具"""
-
-    @staticmethod
-    def format_for_human(context: Dict[str, Any]) -> str:
-        """将上下文格式化为人类可读的文本"""
-        result = []
-
-        # 添加标题（如果有）
-        if "title" in context:
-            result.append(f"# {context['title']}\n")
-
-        # 添加描述（如果有）
-        if "description" in context:
-            result.append(f"{context['description']}\n")
-
-        # 添加任务信息
-        if "task" in context:
-            result.append(f"## 任务\n{context['task']}\n")
-
-        # 添加代理信息
-        if "agent" in context:
-            result.append(f"## 代理\n{context['agent']}\n")
-
-        # 添加操作信息
-        if "action" in context:
-            result.append(f"## 请求的操作\n{context['action']}\n")
-
-        # 添加原因
-        if "reason" in context:
-            result.append(f"## 原因\n{context['reason']}\n")
-
-        # 添加其他键值对
-        other_keys = [
-            k
-            for k in context.keys()
-            if k not in ["title", "description", "task", "agent", "action", "reason"]
-        ]
-        if other_keys:
-            result.append("## 附加信息\n")
-            for key in other_keys:
-                value = context[key]
-                if isinstance(value, (dict, list)):
-                    value = json.dumps(value, ensure_ascii=False, indent=2)
-                result.append(f"### {key}\n```\n{value}\n```\n")
-
-        return "\n".join(result)
-
-    @staticmethod
-    def format_for_api(context: Dict[str, Any]) -> Dict[str, Any]:
-        """将上下文格式化为API友好的格式"""
-        # 复制上下文以避免修改原始数据
-        formatted = context.copy()
-
-        # 确保所有值都是可序列化的
-        for key, value in formatted.items():
-            if not isinstance(value, (str, int, float, bool, list, dict, type(None))):
-                formatted[key] = str(value)
-
-        return formatted
+import inspect
+from typing import Callable, Any, Dict, Union, cast
+
+
+def _param_detail_zh(p: inspect.Parameter) -> str:
+    return (
+        f"    {p.name}: "
+        + (f"类型[{p.annotation}] " if p.annotation != p.empty else "")
+        + (f"(默认值={p.default})" if p.default != p.empty else "")
+    )
+
+
+def _param_detail_en(p: inspect.Parameter) -> str:
+    return (
+        f"    {p.name}: "
+        + (f"Type[{p.annotation}] " if p.annotation != p.empty else "")
+        + (f"(default={p.default})" if p.default != p.empty else "")
+    )
+
+
+def generate_function_summary(
+    fn: Callable,
+    *args: Any,
+    language: str = "zh",
+    **kwargs: Any,
+) -> str:
+    """生成支持中英文切换的函数说明模板
+
+    Args:
+        fn: 目标函数
+        *args: 位置参数示例
+        **kwargs: 关键字参数示例
+        language: 输出语言 ('zh'/'en')
+
+    Returns:
+        纯文本格式的函数说明
+    """
+
+    # 定义翻译类型
+
+    # 语言配置
+    translations: Dict[
+        str, Dict[str, Union[str, Callable[[inspect.Parameter], str]]]
+    ] = {
+        "zh": {
+            "title": "函数说明",
+            "name": "函数名称",
+            "module": "所属模块",
+            "description": "功能描述",
+            "params": "参数列表",
+            "param_detail": _param_detail_zh,
+            "return": "返回值类型",
+            "current_input": "当前输入",
+            "positional_args": "位置参数",
+            "keyword_args": "关键字参数",
+            "usage": "调用方式",
+            "approval": "审批状态",
+            "no_doc": "无文档说明",
+        },
+        "en": {
+            "title": "Function Documentation",
+            "name": "Function Name",
+            "module": "Module",
+            "description": "Description",
+            "params": "Parameters",
+            "param_detail": _param_detail_en,
+            "return": "Return Type",
+            "current_input": "Current Input",
+            "positional_args": "Positional Args",
+            "keyword_args": "Keyword Args",
+            "usage": "Usage",
+            "approval": "Approval Status",
+            "no_doc": "No documentation",
+        },
+    }
+
+    lang = translations.get(language, translations["zh"])
+
+    # 明确告诉类型检查器这是一个可调用对象
+    param_detail_func = cast(Callable[[inspect.Parameter], str], lang["param_detail"])
+
+    # 获取函数信息
+    func_name = fn.__name__
+    module_obj = inspect.getmodule(fn)
+    module = module_obj.__name__ if module_obj is not None else str(lang["no_doc"])
+    doc = (fn.__doc__ or str(lang["no_doc"])).strip()
+    sig = inspect.signature(fn)
+
+    # 构建模板
+    template = (
+        f"""
+- {lang['title']}: {func_name}
+- {lang['name']}: {func_name}
+- {lang['module']}: {module}
+
+- {lang['description']}:
+{doc}
+
+- {lang['params']}:
+"""
+        + "\n".join(param_detail_func(p) for p in sig.parameters.values())
+        + f"""
+
+- {lang['return']}: {sig.return_annotation if sig.return_annotation != sig.empty else lang['no_doc']}
+
+- {lang['current_input']}:
+{lang['positional_args']}: {args}
+{lang['keyword_args']}: {kwargs}
+
+- {lang['usage']}: {func_name}(*{args}, **{kwargs})
+
+"""
+    )
+    return template.strip()
+
+
+if __name__ == "__main__":
+    # 示例函数
+    def calculate(a: int, b: float = 1.0) -> float:
+        """计算两个数的乘积/Calculate the product of two numbers"""
+        return a * b
+
+    # 中文输出
+    print("==== 中文版 ====")
+    print(generate_function_summary(calculate, 3, b=2.5))
+
+    # 英文输出
+    print("\n==== English Version ====")
+    print(
+        generate_function_summary(
+            calculate,
+            3,
+            language="en",
+            b=2.5,
+        )
+    )

{gohumanloop-0.0.10.dist-info → gohumanloop-0.0.11.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gohumanloop
-Version: 0.0.10
+Version: 0.0.11
 Summary: Perfecting AI workflows with human intelligence
 Author-email: gohumanloop authors <baird0917@163.com>
 Project-URL: repository, https://github.com/ptonlix/gohumanloop

{gohumanloop-0.0.10.dist-info → gohumanloop-0.0.11.dist-info}/RECORD

@@ -1,7 +1,7 @@
 gohumanloop/__init__.py,sha256=KiY2ncM6OQvkBYcz5rsbob_GuV8hQHOARA-EsxAylEU,2134
 gohumanloop/__main__.py,sha256=zdGKN92H9SgwZfL4xLqPkE1YaiRcHhVg_GqC-H1VurA,75
 gohumanloop/adapters/__init__.py,sha256=_XqJ6eaUBLJJJyjfBQJykBZ4X9HvC3VYOVTn2KnBlqo,484
-gohumanloop/adapters/base_adapter.py,sha256=G1Tw7uzBrJObDdVT2kxifotkGZIptnZh5GUqCx54rSs,32884
+gohumanloop/adapters/base_adapter.py,sha256=v5oEeWhdnUI6QL9G-JziMIJmg30RxSozVttAaxZwmmo,33926
 gohumanloop/adapters/langgraph_adapter.py,sha256=AHJv_b6g8xjeq_9X2cGiW76pSGlfgCGBUvjrZQcbR9s,11621
 gohumanloop/cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 gohumanloop/cli/main.py,sha256=Txjk31MlkiX9zeHZfFEXEu0s2IBESY8sxrxBEzZKk2U,767
@@ -19,13 +19,13 @@ gohumanloop/providers/base.py,sha256=rOA9xRTh-rn-64RIZpzcIhWNar8LEzYrEXS5H5r7PpM
 gohumanloop/providers/email_provider.py,sha256=kQA6kG7dqpV6R1cJUeaanLmxMVk9pcIwweNZA4IC-2o,45947
 gohumanloop/providers/ghl_provider.py,sha256=NmOac2LR0d87pc91sMuYtvTYsKdp4wZrhfmSYuZL2ko,2350
 gohumanloop/providers/terminal_provider.py,sha256=aBNgGpspiu7fGigN6K-gqGlyjFDFvIqKMGp58PxGyPg,15447
-gohumanloop/utils/__init__.py,sha256=l0e3lnOVrt6HwaxidNGFXORX4awCKemhJZ_t3k-5u-s,124
-gohumanloop/utils/context_formatter.py,sha256=sAWrKJpxmsHga6gsyBwFBlAsHW8bjR1hkaGhk1PoE1M,2064
+gohumanloop/utils/__init__.py,sha256=WoxyK2JXOp_JtKGTxyH3Drly8hpDXxCTV2-QoHY5N0s,199
+gohumanloop/utils/context_formatter.py,sha256=2ybnESv4-f4F1VKPkm81sbWE6e5h3LHljm5CczdznXg,3783
 gohumanloop/utils/threadsafedict.py,sha256=9uyewnwmvS3u1fCx3SK0YWFxHMcyIwlye1Ev7WW7WHA,9588
 gohumanloop/utils/utils.py,sha256=O0zFtMFloAkWylmZE7WpmAjbDe385ZBfuUEh7NIwgGE,2148
-gohumanloop-0.0.10.dist-info/licenses/LICENSE,sha256=-U5tuCcSpndQwSKWtZbFbazb-_AtZcZL2kQgHbSLg-M,1064
-gohumanloop-0.0.10.dist-info/METADATA,sha256=kpmDmvASjoEsVlgRTtQt87g2ZpGfSeVeRuRVFShq334,11428
-gohumanloop-0.0.10.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-gohumanloop-0.0.10.dist-info/entry_points.txt,sha256=wM6jqRRD8bQXkvIduRVCuAJIlbyWg_F5EDXo5OZ_PwY,88
-gohumanloop-0.0.10.dist-info/top_level.txt,sha256=LvOXBqS6Mspmcuqp81uz0Vjx_m_YI0w06DOPCiI1BfY,12
-gohumanloop-0.0.10.dist-info/RECORD,,
+gohumanloop-0.0.11.dist-info/licenses/LICENSE,sha256=-U5tuCcSpndQwSKWtZbFbazb-_AtZcZL2kQgHbSLg-M,1064
+gohumanloop-0.0.11.dist-info/METADATA,sha256=F3dCnFSie_t_P7Ttw93XPCQCHeRvs-N4oPPQeXU_76w,11428
+gohumanloop-0.0.11.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+gohumanloop-0.0.11.dist-info/entry_points.txt,sha256=wM6jqRRD8bQXkvIduRVCuAJIlbyWg_F5EDXo5OZ_PwY,88
+gohumanloop-0.0.11.dist-info/top_level.txt,sha256=LvOXBqS6Mspmcuqp81uz0Vjx_m_YI0w06DOPCiI1BfY,12
+gohumanloop-0.0.11.dist-info/RECORD,,