Skip to content

OpenSenseNova/SenseNova-Skills / skills/sn-search-code

sn-search-code

Verified

用于查找代码示例、开源项目、GitHub Issue、技术问答、开发者讨论、HuggingFace 模型/数据集/Space。

scripts/search_utils.py

View on GitHub
"""
搜索 Skill 共享工具库。

提供标准 JSON 输出、CLI 脚手架、httpx helper 和配置读取。
所有搜索脚本通过 sys.path 导入此模块。
"""

import argparse
import json
import os
import sys
from pathlib import Path
from typing import Any

def _dependency_hint(package: str) -> str:
    skill_dir = Path(__file__).resolve().parents[1]
    requirements = skill_dir / "requirements.txt"
    return (
        f"缺少依赖 {package}。请安装到当前 Python 环境:"
        f"python3 -m pip install -r {requirements}"
    )


try:
    import httpx
except ImportError as exc:
    raise SystemExit(_dependency_hint("httpx")) from exc

# ---------------------------------------------------------------------------
# 标准输出
# ---------------------------------------------------------------------------

def make_result(
    success: bool,
    query: str,
    provider: str,
    items: list[dict[str, Any]],
    error: str | None = None,
) -> dict[str, Any]:
    """构造标准化的搜索结果。"""
    return {
        "success": success,
        "query": query,
        "provider": provider,
        "items": items,
        "error": error,
    }


def make_item(
    title: str,
    url: str,
    snippet: str = "",
    **extra: Any,
) -> dict[str, Any]:
    """构造标准化的搜索结果条目。"""
    item: dict[str, Any] = {"title": title, "url": url, "snippet": snippet}
    for k, v in extra.items():
        if v not in (None, "", [], {}):
            item[k] = v
    return item


def print_json(data: dict[str, Any]) -> None:
    """将结果 JSON 输出到 stdout。"""
    json.dump(data, sys.stdout, ensure_ascii=False, indent=2)
    sys.stdout.write("\n")
    sys.stdout.flush()


# ---------------------------------------------------------------------------
# CLI 脚手架
# ---------------------------------------------------------------------------

def build_parser(description: str) -> argparse.ArgumentParser:
    """创建带有通用参数的 ArgumentParser。"""
    parser = argparse.ArgumentParser(description=description)
    parser.add_argument("query", help="搜索关键词")
    parser.add_argument("--limit", "-n", type=int, default=10, help="返回结果数量(默认 10)")
    return parser


# ---------------------------------------------------------------------------
# httpx helper
# ---------------------------------------------------------------------------

_DEFAULT_TIMEOUT = 15
_DEFAULT_UA = (
    "Mozilla/5.0 (Windows NT 10.0; Win64; x64) "
    "AppleWebKit/537.36 (KHTML, like Gecko) "
    "Chrome/125.0.0.0 Safari/537.36"
)


def get_client(
    timeout: int = _DEFAULT_TIMEOUT,
    headers: dict[str, str] | None = None,
    **kwargs: Any,
) -> httpx.Client:
    """返回预配置的 httpx.Client。"""
    default_headers = {
        "User-Agent": _DEFAULT_UA,
        "Accept": "application/json",
    }
    if headers:
        default_headers.update(headers)
    return httpx.Client(
        timeout=timeout,
        headers=default_headers,
        follow_redirects=True,
        **kwargs,
    )


# ---------------------------------------------------------------------------
# 配置读取
# ---------------------------------------------------------------------------

def get_key(env_var: str, cli_arg: str | None = None) -> str | None:
    """读取 API key:CLI 参数 > 环境变量。"""
    if cli_arg:
        return cli_arg
    return os.environ.get(env_var)


# ---------------------------------------------------------------------------
# 脚本入口辅助
# ---------------------------------------------------------------------------

def run_search(
    provider: str,
    search_fn,  # Callable[[str, int, ...], list[dict]]
    parser: argparse.ArgumentParser | None = None,
    extra_kwargs_fn=None,  # Callable[[Namespace], dict] 从 args 提取额外参数
) -> None:
    """通用脚本入口:解析参数 → 执行搜索 → 输出 JSON。"""
    if parser is None:
        parser = build_parser(f"Search {provider}")
    args = parser.parse_args()

    extra = {}
    if extra_kwargs_fn:
        extra = extra_kwargs_fn(args)

    try:
        items = search_fn(args.query, args.limit, **extra)
        print_json(make_result(True, args.query, provider, items))
    except Exception as e:
        print_json(make_result(False, args.query, provider, [], str(e)))
        sys.exit(1)
receiving-code-reviewobra/superpowersUse when receiving code review feedback, before implementing suggestions, especially if feedback seems unclear or technically questionable - requires technical rigor and verification, not performative agreement or blind implementationStars: 322kUpdated Claude CodeCodexVerifiedInstall
requesting-code-reviewobra/superpowersUse when completing tasks, implementing major features, or before merging to verify work meets requirementsStars: 322kUpdated Claude CodeCodexVerifiedInstall
using-git-worktreesobra/superpowersUse when starting feature work that needs isolation from current workspace or before executing implementation plans - ensures an isolated workspace exists via native tools or git worktree fallbackStars: 322kUpdated Claude CodeCodexVerifiedInstall
verification-before-completionobra/superpowersUse when about to claim work is complete, fixed, or passing, before committing or creating PRs - requires running verification commands and confirming output before making any success claims; evidence before assertions alwaysStars: 322kUpdated Claude CodeCodexVerifiedInstall