botrun-flow-lang 5.12.263__py3-none-any.whl → 5.12.264__py3-none-any.whl

botrun_flow_lang/tools/generate_docs.py

@@ -1,133 +1,133 @@
-import inspect
-import os
-from pathlib import Path
-from jinja2 import Environment, FileSystemLoader
-from typing import get_type_hints, Any
-import sys
-
-# Add the project root to the Python path
-project_root = Path(__file__).parent.parent.parent
-sys.path.append(str(project_root))
-
-from botrun_flow_lang.langgraph_agents.agents.langgraph_react_agent import (
-    chat_with_pdf,
-    chat_with_imgs,
-    current_date_time,
-    scrape,
-    web_search,
-    # deep_research,
-    create_mermaid_diagram,
-    create_plotly_chart,
-    generate_image,
-    generate_tmp_public_url,
-    create_html_page,
-)
-
-# List of tool functions to document
-TOOLS = sorted(
-    [
-        chat_with_imgs,
-        chat_with_pdf,
-        create_mermaid_diagram,
-        create_plotly_chart,
-        current_date_time,
-        generate_image,
-        generate_tmp_public_url,
-        scrape,
-        web_search,
-        # deep_research,
-        create_html_page,
-    ],
-    key=lambda x: x.name,
-)
-
-
-def get_tool_info(tool):
-    """Extract documentation information from a tool function."""
-    # 處理 LangChain 工具
-    if hasattr(tool, "name"):
-        func_name = tool.name
-    else:
-        func_name = tool.__name__
-
-    # 獲取文檔字符串
-    if hasattr(tool, "description"):
-        doc = tool.description
-    else:
-        doc = inspect.getdoc(tool) or "No documentation available."
-
-    # 獲取簽名
-    if hasattr(tool, "func"):
-        sig = inspect.signature(tool.func)
-    else:
-        sig = inspect.signature(tool)
-
-    # Get parameters info
-    parameters = []
-    for name, param in sig.parameters.items():
-        annotation = (
-            str(param.annotation)
-            if param.annotation != inspect.Parameter.empty
-            else "Any"
-        )
-        if "Annotated" in annotation:
-            # 簡化 Annotated 類型
-            annotation = annotation.split("[")[1].split(",")[0]
-        parameters.append(
-            {
-                "name": name,
-                "annotation": annotation,
-                "default": (
-                    None
-                    if param.default == inspect.Parameter.empty
-                    else str(param.default)
-                ),
-            }
-        )
-
-    # Get return annotation
-    return_annotation = (
-        str(sig.return_annotation)
-        if sig.return_annotation != inspect.Signature.empty
-        else "Any"
-    )
-    if "Annotated" in return_annotation:
-        # 簡化 Annotated 類型
-        return_annotation = return_annotation.split("[")[1].split(",")[0]
-
-    return {
-        "name": func_name,
-        "doc": doc,
-        "parameters": parameters,
-        "return_annotation": return_annotation,
-    }
-
-
-def generate_html_docs():
-    """Generate HTML documentation for all tool functions."""
-    # Setup Jinja2 environment
-    env = Environment(
-        loader=FileSystemLoader(os.path.join(os.path.dirname(__file__), "templates"))
-    )
-    template = env.get_template("tools.html")
-
-    # Get documentation for all tools
-    tools_info = [get_tool_info(tool) for tool in TOOLS]
-
-    # Render the template
-    html_content = template.render(tools=tools_info)
-
-    # Ensure the output directory exists
-    output_dir = Path(project_root) / "botrun_flow_lang" / "static" / "docs" / "tools"
-    output_dir.mkdir(parents=True, exist_ok=True)
-
-    # Write the HTML file
-    output_file = output_dir / "index.html"
-    with open(output_file, "w", encoding="utf-8") as f:
-        f.write(html_content)
-
-    print(f"Documentation generated at: {output_file}")
-
-
-if __name__ == "__main__":
-    generate_html_docs()
+import inspect
+import os
+from pathlib import Path
+from jinja2 import Environment, FileSystemLoader
+from typing import get_type_hints, Any
+import sys
+
+# Add the project root to the Python path
+project_root = Path(__file__).parent.parent.parent
+sys.path.append(str(project_root))
+
+from botrun_flow_lang.langgraph_agents.agents.langgraph_react_agent import (
+    chat_with_pdf,
+    chat_with_imgs,
+    current_date_time,
+    scrape,
+    web_search,
+    # deep_research,
+    create_mermaid_diagram,
+    create_plotly_chart,
+    generate_image,
+    generate_tmp_public_url,
+    create_html_page,
+)
+
+# List of tool functions to document
+TOOLS = sorted(
+    [
+        chat_with_imgs,
+        chat_with_pdf,
+        create_mermaid_diagram,
+        create_plotly_chart,
+        current_date_time,
+        generate_image,
+        generate_tmp_public_url,
+        scrape,
+        web_search,
+        # deep_research,
+        create_html_page,
+    ],
+    key=lambda x: x.name,
+)
+
+
+def get_tool_info(tool):
+    """Extract documentation information from a tool function."""
+    # 處理 LangChain 工具
+    if hasattr(tool, "name"):
+        func_name = tool.name
+    else:
+        func_name = tool.__name__
+
+    # 獲取文檔字符串
+    if hasattr(tool, "description"):
+        doc = tool.description
+    else:
+        doc = inspect.getdoc(tool) or "No documentation available."
+
+    # 獲取簽名
+    if hasattr(tool, "func"):
+        sig = inspect.signature(tool.func)
+    else:
+        sig = inspect.signature(tool)
+
+    # Get parameters info
+    parameters = []
+    for name, param in sig.parameters.items():
+        annotation = (
+            str(param.annotation)
+            if param.annotation != inspect.Parameter.empty
+            else "Any"
+        )
+        if "Annotated" in annotation:
+            # 簡化 Annotated 類型
+            annotation = annotation.split("[")[1].split(",")[0]
+        parameters.append(
+            {
+                "name": name,
+                "annotation": annotation,
+                "default": (
+                    None
+                    if param.default == inspect.Parameter.empty
+                    else str(param.default)
+                ),
+            }
+        )
+
+    # Get return annotation
+    return_annotation = (
+        str(sig.return_annotation)
+        if sig.return_annotation != inspect.Signature.empty
+        else "Any"
+    )
+    if "Annotated" in return_annotation:
+        # 簡化 Annotated 類型
+        return_annotation = return_annotation.split("[")[1].split(",")[0]
+
+    return {
+        "name": func_name,
+        "doc": doc,
+        "parameters": parameters,
+        "return_annotation": return_annotation,
+    }
+
+
+def generate_html_docs():
+    """Generate HTML documentation for all tool functions."""
+    # Setup Jinja2 environment
+    env = Environment(
+        loader=FileSystemLoader(os.path.join(os.path.dirname(__file__), "templates"))
+    )
+    template = env.get_template("tools.html")
+
+    # Get documentation for all tools
+    tools_info = [get_tool_info(tool) for tool in TOOLS]
+
+    # Render the template
+    html_content = template.render(tools=tools_info)
+
+    # Ensure the output directory exists
+    output_dir = Path(project_root) / "botrun_flow_lang" / "static" / "docs" / "tools"
+    output_dir.mkdir(parents=True, exist_ok=True)
+
+    # Write the HTML file
+    output_file = output_dir / "index.html"
+    with open(output_file, "w", encoding="utf-8") as f:
+        f.write(html_content)
+
+    print(f"Documentation generated at: {output_file}")
+
+
+if __name__ == "__main__":
+    generate_html_docs()

botrun_flow_lang/tools/templates/tools.html

@@ -1,154 +1,154 @@
-<!DOCTYPE html>
-<html lang="zh-TW">
-<head>
-    <meta charset="UTF-8">
-    <meta name="viewport" content="width=device-width, initial-scale=1.0">
-    <title>ReAct Agent Tools Documentation</title>
-    <link href="https://cdn.jsdelivr.net/npm/bootstrap@5.1.3/dist/css/bootstrap.min.css" rel="stylesheet">
-    <link href="https://cdn.jsdelivr.net/npm/prismjs@1.29.0/themes/prism.min.css" rel="stylesheet">
-    <style>
-        .tool-section {
-            margin-bottom: 2rem;
-            padding: 1rem;
-            border: 1px solid #dee2e6;
-            border-radius: 0.25rem;
-        }
-        .tool-name {
-            color: #0d6efd;
-            margin-bottom: 1rem;
-            padding-top: 60px;  /* 為固定導航欄留出空間 */
-            margin-top: -60px;  /* 抵消 padding-top */
-        }
-        .param-table {
-            margin-top: 1rem;
-        }
-        .doc-content {
-            white-space: pre-wrap;
-            font-family: monospace;
-            background-color: #f8f9fa;
-            padding: 1rem;
-            border-radius: 0.25rem;
-        }
-        #sidebar {
-            position: fixed;
-            top: 0;
-            left: 0;
-            height: 100vh;
-            width: 250px;
-            background-color: #f8f9fa;
-            padding: 20px;
-            overflow-y: auto;
-            border-right: 1px solid #dee2e6;
-        }
-        #main-content {
-            margin-left: 250px;
-            padding: 20px;
-        }
-        .nav-link {
-            color: #0d6efd;
-            padding: 5px 0;
-        }
-        .nav-link:hover {
-            background-color: #e9ecef;
-        }
-        .nav-link.active {
-            font-weight: bold;
-            background-color: #e9ecef;
-        }
-    </style>
-</head>
-<body>
-    <div id="sidebar">
-        <h5 class="mb-3">Tools</h5>
-        <nav class="nav flex-column">
-            {% for tool in tools %}
-            <a class="nav-link" href="#{{ tool.name }}">{{ tool.name }}</a>
-            {% endfor %}
-        </nav>
-    </div>
-
-    <div id="main-content">
-        <h1 class="mb-4">ReAct Agent Tools Documentation</h1>
-        
-        <div class="row">
-            <div class="col-12">
-                {% for tool in tools %}
-                <div class="tool-section" id="{{ tool.name }}">
-                    <h2 class="tool-name">@tool {{ tool.name }}</h2>
-                    
-                    <h4>Documentation:</h4>
-                    <div class="doc-content">{{ tool.doc }}</div>
-                    
-                    <h4 class="mt-3">Parameters:</h4>
-                    <table class="table param-table">
-                        <thead>
-                            <tr>
-                                <th>Name</th>
-                                <th>Type</th>
-                                <th>Default</th>
-                            </tr>
-                        </thead>
-                        <tbody>
-                            {% for param in tool.parameters %}
-                            <tr>
-                                <td>{{ param.name }}</td>
-                                <td><code>{{ param.annotation }}</code></td>
-                                <td>{% if param.default != None %}<code>{{ param.default }}</code>{% else %}-{% endif %}</td>
-                            </tr>
-                            {% endfor %}
-                        </tbody>
-                    </table>
-                    
-                    <h4 class="mt-3">Returns:</h4>
-                    <code>{{ tool.return_annotation }}</code>
-                </div>
-                {% endfor %}
-            </div>
-        </div>
-    </div>
-
-    <script src="https://cdn.jsdelivr.net/npm/bootstrap@5.1.3/dist/js/bootstrap.bundle.min.js"></script>
-    <script src="https://cdn.jsdelivr.net/npm/prismjs@1.29.0/prism.min.js"></script>
-    <script>
-        // 高亮當前選中的導航項
-        document.addEventListener('DOMContentLoaded', function() {
-            const navLinks = document.querySelectorAll('.nav-link');
-            
-            // 監聽滾動事件
-            window.addEventListener('scroll', function() {
-                let currentSection = '';
-                const sections = document.querySelectorAll('.tool-section');
-                
-                sections.forEach(section => {
-                    const sectionTop = section.offsetTop;
-                    const sectionHeight = section.clientHeight;
-                    if (pageYOffset >= sectionTop - 100) {
-                        currentSection = section.getAttribute('id');
-                    }
-                });
-                
-                // 更新導航項的激活狀態
-                navLinks.forEach(link => {
-                    link.classList.remove('active');
-                    if (link.getAttribute('href').substring(1) === currentSection) {
-                        link.classList.add('active');
-                    }
-                });
-            });
-            
-            // 平滑滾動
-            navLinks.forEach(link => {
-                link.addEventListener('click', function(e) {
-                    e.preventDefault();
-                    const targetId = this.getAttribute('href').substring(1);
-                    const targetElement = document.getElementById(targetId);
-                    window.scrollTo({
-                        top: targetElement.offsetTop - 20,
-                        behavior: 'smooth'
-                    });
-                });
-            });
-        });
-    </script>
-</body>
+<!DOCTYPE html>
+<html lang="zh-TW">
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>ReAct Agent Tools Documentation</title>
+    <link href="https://cdn.jsdelivr.net/npm/bootstrap@5.1.3/dist/css/bootstrap.min.css" rel="stylesheet">
+    <link href="https://cdn.jsdelivr.net/npm/prismjs@1.29.0/themes/prism.min.css" rel="stylesheet">
+    <style>
+        .tool-section {
+            margin-bottom: 2rem;
+            padding: 1rem;
+            border: 1px solid #dee2e6;
+            border-radius: 0.25rem;
+        }
+        .tool-name {
+            color: #0d6efd;
+            margin-bottom: 1rem;
+            padding-top: 60px;  /* 為固定導航欄留出空間 */
+            margin-top: -60px;  /* 抵消 padding-top */
+        }
+        .param-table {
+            margin-top: 1rem;
+        }
+        .doc-content {
+            white-space: pre-wrap;
+            font-family: monospace;
+            background-color: #f8f9fa;
+            padding: 1rem;
+            border-radius: 0.25rem;
+        }
+        #sidebar {
+            position: fixed;
+            top: 0;
+            left: 0;
+            height: 100vh;
+            width: 250px;
+            background-color: #f8f9fa;
+            padding: 20px;
+            overflow-y: auto;
+            border-right: 1px solid #dee2e6;
+        }
+        #main-content {
+            margin-left: 250px;
+            padding: 20px;
+        }
+        .nav-link {
+            color: #0d6efd;
+            padding: 5px 0;
+        }
+        .nav-link:hover {
+            background-color: #e9ecef;
+        }
+        .nav-link.active {
+            font-weight: bold;
+            background-color: #e9ecef;
+        }
+    </style>
+</head>
+<body>
+    <div id="sidebar">
+        <h5 class="mb-3">Tools</h5>
+        <nav class="nav flex-column">
+            {% for tool in tools %}
+            <a class="nav-link" href="#{{ tool.name }}">{{ tool.name }}</a>
+            {% endfor %}
+        </nav>
+    </div>
+
+    <div id="main-content">
+        <h1 class="mb-4">ReAct Agent Tools Documentation</h1>
+        
+        <div class="row">
+            <div class="col-12">
+                {% for tool in tools %}
+                <div class="tool-section" id="{{ tool.name }}">
+                    <h2 class="tool-name">@tool {{ tool.name }}</h2>
+                    
+                    <h4>Documentation:</h4>
+                    <div class="doc-content">{{ tool.doc }}</div>
+                    
+                    <h4 class="mt-3">Parameters:</h4>
+                    <table class="table param-table">
+                        <thead>
+                            <tr>
+                                <th>Name</th>
+                                <th>Type</th>
+                                <th>Default</th>
+                            </tr>
+                        </thead>
+                        <tbody>
+                            {% for param in tool.parameters %}
+                            <tr>
+                                <td>{{ param.name }}</td>
+                                <td><code>{{ param.annotation }}</code></td>
+                                <td>{% if param.default != None %}<code>{{ param.default }}</code>{% else %}-{% endif %}</td>
+                            </tr>
+                            {% endfor %}
+                        </tbody>
+                    </table>
+                    
+                    <h4 class="mt-3">Returns:</h4>
+                    <code>{{ tool.return_annotation }}</code>
+                </div>
+                {% endfor %}
+            </div>
+        </div>
+    </div>
+
+    <script src="https://cdn.jsdelivr.net/npm/bootstrap@5.1.3/dist/js/bootstrap.bundle.min.js"></script>
+    <script src="https://cdn.jsdelivr.net/npm/prismjs@1.29.0/prism.min.js"></script>
+    <script>
+        // 高亮當前選中的導航項
+        document.addEventListener('DOMContentLoaded', function() {
+            const navLinks = document.querySelectorAll('.nav-link');
+            
+            // 監聽滾動事件
+            window.addEventListener('scroll', function() {
+                let currentSection = '';
+                const sections = document.querySelectorAll('.tool-section');
+                
+                sections.forEach(section => {
+                    const sectionTop = section.offsetTop;
+                    const sectionHeight = section.clientHeight;
+                    if (pageYOffset >= sectionTop - 100) {
+                        currentSection = section.getAttribute('id');
+                    }
+                });
+                
+                // 更新導航項的激活狀態
+                navLinks.forEach(link => {
+                    link.classList.remove('active');
+                    if (link.getAttribute('href').substring(1) === currentSection) {
+                        link.classList.add('active');
+                    }
+                });
+            });
+            
+            // 平滑滾動
+            navLinks.forEach(link => {
+                link.addEventListener('click', function(e) {
+                    e.preventDefault();
+                    const targetId = this.getAttribute('href').substring(1);
+                    const targetElement = document.getElementById(targetId);
+                    window.scrollTo({
+                        top: targetElement.offsetTop - 20,
+                        behavior: 'smooth'
+                    });
+                });
+            });
+        });
+    </script>
+</body>
 </html> 

botrun_flow_lang/utils/__init__.py

@@ -1,7 +1,7 @@
-from botrun_flow_lang.utils.botrun_logger import (
-    BotrunLogger,
-    get_default_botrun_logger,
-    get_session_botrun_logger,
-)
-
-__all__ = ["BotrunLogger", "get_default_botrun_logger", "get_session_botrun_logger"]
+from botrun_flow_lang.utils.botrun_logger import (
+    BotrunLogger,
+    get_default_botrun_logger,
+    get_session_botrun_logger,
+)
+
+__all__ = ["BotrunLogger", "get_default_botrun_logger", "get_session_botrun_logger"]