siada-cli 0.0.1__py3-none-any.whl

siada/tools/web/web_crawl.py

@@ -0,0 +1,208 @@
+"""
+Web content crawling tool
+
+Uses trafilatura library to fetch web content, supports multiple output formats
+"""
+
+WEB_CRAWL_DOCS = """Web content crawling tool for fetching and extracting content from web pages
+* Uses trafilatura library to intelligently extract clean content from web pages
+* Supports multiple output formats: text, markdown, JSON, and raw HTML
+* Handles various web page types including articles, blogs, documentation, and news sites
+* Automatically validates URLs and provides detailed error messages for troubleshooting
+* Returns structured observation objects with success status and extracted content
+
+SUPPORTED OUTPUT FORMATS:
+- `text`: Clean plain text content without HTML tags (default)
+- `markdown`: Content formatted as Markdown with preserved structure
+- `json`: Structured JSON format with metadata including title, author, date, etc.
+- `html`: Raw HTML content as downloaded from the source
+
+USAGE GUIDELINES:
+
+Before using this tool:
+1. Ensure the target URL is accessible and contains the content you need
+2. Choose the appropriate output format based on your use case:
+   - Use `text` for simple content analysis or when you need clean readable text
+   - Use `markdown` when you need to preserve document structure and formatting
+   - Use `json` when you need metadata along with content (title, publication date, etc.)
+   - Use `html` when you need the raw source code for further processing
+
+When using this tool:
+1. Always provide a complete, valid URL including the protocol (http:// or https://)
+2. The tool will automatically validate the URL format before attempting to fetch content
+3. If the request fails, check the error message for specific details about the failure
+4. Large pages may take some time to process, especially when extracting to JSON format
+
+COMMON USE CASES:
+- Research: Extract article content from news sites, blogs, or documentation
+- Content Analysis: Get clean text for sentiment analysis or keyword extraction
+- Documentation: Convert web pages to markdown for documentation purposes
+- Data Collection: Extract structured data from web pages in JSON format
+- Web Scraping: Get raw HTML for custom parsing and data extraction
+
+ERROR HANDLING:
+The tool provides detailed error messages for common issues:
+- Invalid URL format: Check that the URL includes protocol and domain
+- Network request failed: Check internet connection and URL accessibility
+- Unable to download content: The target page may be protected or unavailable
+- Unable to extract content: The page structure may not be supported by trafilatura
+- JSON parsing failed: The extracted content could not be formatted as valid JSON
+
+EXAMPLES:
+- web_crawl(url="https://example.com/article", format="text")
+- web_crawl(url="https://docs.example.com/guide", format="markdown")
+- web_crawl(url="https://news.example.com/story", format="json")
+- web_crawl(url="https://example.com/page", format="html")
+
+Args:
+    context: Runtime context wrapper for the agent
+    url: Complete URL of the webpage to crawl (must include protocol)
+    format: Output format - "text", "markdown", "json", or "html" (default: "text")
+
+Returns:
+    WebCrawlObservation: Object containing the crawling results with success status and content
+"""
+import json
+import logging
+from typing import Literal
+import trafilatura
+import requests
+from urllib.parse import urlparse
+from agents import function_tool, RunContextWrapper
+
+from siada.foundation.code_agent_context import CodeAgentContext
+from siada.tools.coder.observation.observation import FunctionCallResult
+
+
+class WebCrawlObservation(FunctionCallResult):
+    """Web crawling result observation"""
+
+    def __init__(self, url: str, content: str, format: str, success: bool = True, error: str = None):
+        self.url = url
+        self.content = content
+        self.format = format
+        self.success = success
+        self.error = error
+
+    def __str__(self) -> str:
+        if not self.success:
+            return f"Web crawling failed ({self.url}): {self.error}"
+
+        content_preview = self.content[:200] + "..." if len(self.content) > 200 else self.content
+        return f"Web crawling successful ({self.url}, format: {self.format}):\n{content_preview}"
+
+
+@function_tool(name_override="web_crawl",
+               description_override="Complete the bug fix task and mark it as finished. This tool MUST be called to properly complete any bug fix task. Failure to call this tool means the bug fix task is incomplete and unacceptable."
+               )
+def web_crawl(
+        context: RunContextWrapper[CodeAgentContext],
+        url: str,
+        format: Literal["markdown", "text", "json", "html"] = "text"
+) -> WebCrawlObservation:
+    """
+    Crawl web content and return content in specified format
+    
+    Args:
+        context: Runtime context wrapper
+        url: URL of the webpage to crawl
+        format: Output format, supports "markdown", "text", "json", "html"
+        
+    Returns:
+        WebCrawlObservation: Observation object containing crawling results
+    """
+    try:
+        # Validate URL format
+        parsed_url = urlparse(url)
+        if not parsed_url.scheme or not parsed_url.netloc:
+            return WebCrawlObservation(
+                url=url,
+                content="",
+                format=format,
+                success=False,
+                error=f"Invalid URL format: {url}"
+            )
+
+        # Download web content
+        downloaded = trafilatura.fetch_url(url)
+        if not downloaded:
+            return WebCrawlObservation(
+                url=url,
+                content="",
+                format=format,
+                success=False,
+                error=f"Unable to download web content: {url}"
+            )
+
+        if format == "html":
+            extracted = downloaded
+        elif format == "text":
+            extracted = trafilatura.extract(downloaded, output_format='txt')
+        elif format == "markdown":
+            extracted = trafilatura.extract(downloaded, output_format='markdown')
+        elif format == "json":
+            extracted_data = trafilatura.extract(
+                downloaded,
+                output_format='json',
+                include_comments=False,
+                include_tables=True,
+                include_images=True
+            )
+            if extracted_data:
+                # Parse JSON and reformat
+                json_data = json.loads(extracted_data)
+                extracted = json.dumps(json_data, ensure_ascii=False, indent=2)
+            else:
+                extracted = None
+        else:
+            return WebCrawlObservation(
+                url=url,
+                content="",
+                format=format,
+                success=False,
+                error=f"Unsupported format: {format}"
+            )
+
+        if not extracted:
+            return WebCrawlObservation(
+                url=url,
+                content="",
+                format=format,
+                success=False,
+                error=f"Unable to extract content from webpage: {url}"
+            )
+
+        return WebCrawlObservation(
+            url=url,
+            content=extracted,
+            format=format,
+            success=True
+        )
+
+    except requests.exceptions.RequestException as e:
+        error_msg = f"Network request failed: {str(e)}"
+        return WebCrawlObservation(
+            url=url,
+            content="",
+            format=format,
+            success=False,
+            error=error_msg
+        )
+    except json.JSONDecodeError as e:
+        error_msg = f"JSON parsing failed: {str(e)}"
+        return WebCrawlObservation(
+            url=url,
+            content="",
+            format=format,
+            success=False,
+            error=error_msg
+        )
+    except Exception as e:
+        error_msg = f"Web crawling failed: {str(e)}"
+        return WebCrawlObservation(
+            url=url,
+            content="",
+            format=format,
+            success=False,
+            error=error_msg
+        )

siada/utils.py

@@ -0,0 +1,194 @@
+"""
+工具函数模块
+
+提供项目中通用的工具函数
+"""
+import json
+import traceback
+from inspect import stack
+from textwrap import indent
+from typing import Any, Dict, Union, List
+
+from siada.foundation.logging import logger
+
+
+class JsonUtils:
+    """JSON相关工具类"""
+    
+    @staticmethod
+    def format_json(json_data: Union[str, Dict[str, Any]]) -> str:
+        """
+        美化JSON数据
+        
+        Args:
+            json_data: JSON字符串或字典对象
+            
+        Returns:
+            格式化后的JSON字符串
+        """
+        try:
+            # 如果是字符串，先解析为对象
+            if isinstance(json_data, str):
+                data_obj = json.loads(json_data)
+            else:
+                data_obj = json_data
+                
+            # 格式化输出
+            return json.dumps(data_obj, indent=2, ensure_ascii=False)
+        except (json.JSONDecodeError, TypeError):
+            # 解析失败则返回原始内容
+            return str(json_data) 
+
+
+class SSEUtils:
+    """Server-Sent Events (SSE)相关工具类"""
+    
+    @staticmethod
+    async def format_sse(data):
+        """
+        将数据格式化为SSE格式
+        
+        Args:
+            data: 要格式化的数据
+            
+        Returns:
+            SSE格式的数据
+        """
+        if isinstance(data, dict):
+            event = data.get("event", "message")
+            # json.dumps已经会将换行符转为\n转义序列
+            json_data = json.dumps(data.get("data", {}), ensure_ascii=False)
+            return f"event: {event}\ndata: {json_data}\n\n"
+        
+        json_str = json.dumps(data, ensure_ascii=False)
+        return f"data: {json_str}\n\n" 
+
+
+class AgentLogger:
+    """Agent日志格式化助手类"""
+    
+    @staticmethod
+    def format_start(agent_name: str) -> str:
+        """格式化Agent启动日志"""
+        return f"Agent {agent_name} start running"
+    
+    @staticmethod
+    def format_finished(agent_name: str) -> str:
+        """格式化Agent完成日志"""
+        return f"Agent {agent_name} finished"
+    
+    @staticmethod
+    def format_tool_call(tool_name: str, tool_args: Any) -> str:
+        """格式化工具调用日志"""
+        formatted_args = JsonUtils.format_json(tool_args)
+        return f"**Tool Call**\nToolName:{tool_name}\nArguments: {formatted_args}"
+    
+    @staticmethod
+    def format_tool_output(output: str) -> str:
+        """格式化工具输出日志"""
+        return f"**Tool Call Output**\n{output}"
+    
+    @staticmethod
+    def format_action(thought: str, action: str) -> str:
+        """格式化行动日志"""
+        if thought:
+            return f"**Thought**\n{thought} \n{action}"
+        return action
+    
+    @staticmethod
+    def format_final_output(output: str) -> str:
+        """格式化最终输出日志"""
+        return f"{output}"
+    
+    @staticmethod
+    def log_user_input(input_text: str) -> None:
+        """记录用户输入"""
+        logger.info(input_text, extra={'msg_type': 'USER_ACTION'})
+    
+    @staticmethod
+    def log_tool_output(output: str) -> None:
+        """记录工具输出"""
+        logger.info(output, extra={'msg_type': 'OBSERVATION'})
+    
+    @staticmethod
+    def log_action(message: str) -> None:
+        """记录行动"""
+        logger.info(message, extra={'msg_type': 'ACTION'})
+    
+    @staticmethod
+    def log_final_output(message: str) -> None:
+        """记录最终输出"""
+        logger.info(message.lstrip(), extra={"msg_type": "OUTPUT"})
+    
+    @staticmethod
+    def format_observation(thought: str) -> str:
+        """格式化观察日志"""
+        return f"**Observation**\n{thought}"
+    
+    @staticmethod
+    def format_msg_action(thought: str) -> str:
+        """格式化观察日志"""
+        return f"**Message**\n{thought}"
+    
+    @staticmethod
+    def log_observation(message: str) -> None:
+        """记录观察内容"""
+        logger.info(message, extra={'msg_type': 'MESSAGE'})
+
+
+class DebugUtils:
+    "Debug Utils"
+
+    @staticmethod
+    def _cvt(s: Any):
+        if isinstance(s, str):
+            return s
+        try:
+            return json.dumps(s, indent=4)
+        except TypeError:
+            return str(s)
+
+    def dump(*args):
+        stack = traceback.extract_stack()
+        vars = stack[-2][-3]
+
+        vars = "(".join(vars.split("(")[1:])
+        vars = ")".join(vars.split(")")[:-1])
+
+        args = [DebugUtils._cvt(v) for v in args]
+        has_newline = sum(1 for v in vars if "\n" in v)
+        if has_newline:
+            print("%s:" % vars)
+            print(",".join(args))
+        else:
+            print("%s:" % vars, ", ".join(args))
+
+
+class ImageUtils:
+    """Image Utils"""
+    IMAGE_EXTENSIONS = [".png", ".jpg", ".jpeg", ".gif", ".bmp", ".tiff", ".webp", ".pdf"]
+
+    @staticmethod
+    def is_image_file(filename: str) -> bool:
+        """Check if a file is an image file"""
+        file_name = str(filename)  # Convert file_name to string
+        return any(file_name.endswith(ext) for ext in ImageUtils.IMAGE_EXTENSIONS)
+    
+
+class SettingsUtils:
+
+    @staticmethod
+    def format_settings(parser, args):
+        """Format settings"""
+        show = parser.format_values()
+        # clean up the headings for consistency w/ new lines
+        heading_env = "Environment Variables:"
+        heading_defaults = "Defaults:"
+        if heading_env in show:
+            show = show.replace(heading_env, "\n" + heading_env)
+            show = show.replace(heading_defaults, "\n" + heading_defaults)
+        show += "\n"
+        show += "Option settings:\n"
+        for arg, val in sorted(vars(args).items()):
+            show += f"  - {arg}: {val}\n"  # noqa: E221
+        return show

siada_cli-0.0.1.dist-info/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright (c) 2025 Li Auto Inc. and its affiliates
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.