d63e380324
Every PLUGIN-COMPAT __getattr__ now calls hermes_cli.plugin_compat.warn_once(facade, name, target) before
resolving, emitting a HermesPluginCompatWarning (FutureWarning) once per process per name: old path, new
path, removal target. Importing a facade for its live API stays silent; only resolving a moved name warns.
COMPAT_MANIFEST.md documents the warning and how to silence it during migration.
Verified the runtime never routes through a pointer: every entry point (run_agent, cli, hermes_cli.main,
gateway.run, tui_gateway.server, web_server, model_tools + tool discovery, hermes_state, cron.scheduler,
browser_tool, mcp_tool, kanban, auth) imports clean and `hermes doctor` runs end to end with the warning
promoted to an error.
Also restores the check_compat_pointers CI step to .github/workflows/lint.yml, which a0be177aac dropped
when the compat layer was regenerated (the lint script itself was present; the workflow step was not).
hermes_cli/plugin_compat.py, tests/test_plugin_compat_warning.py and the two-line insert per facade are
part of the compat layer and go away with it.
96 lines
3.5 KiB
Python
96 lines
3.5 KiB
Python
"""Feishu Document Tool -- read document content via Feishu/Lark API.
|
|
|
|
Provides ``feishu_doc_read`` for reading document content as plain text.
|
|
Uses the same lazy-import + BaseRequest pattern as feishu_comment.py.
|
|
"""
|
|
|
|
from tools.feishu_lark import ( # noqa: F401 (set_client/get_client are imported by feishu_comment)
|
|
_check_feishu,
|
|
build_request,
|
|
get_client,
|
|
raw_body,
|
|
set_client)
|
|
from tools.registry import registry, tool_error, tool_result
|
|
|
|
_RAW_CONTENT_URI = "/open-apis/docx/v1/documents/:document_id/raw_content"
|
|
|
|
FEISHU_DOC_READ_SCHEMA = {
|
|
"name": "feishu_doc_read",
|
|
"description": (
|
|
"Read the full content of a Feishu/Lark document as plain text. "
|
|
"Useful when you need more context beyond the quoted text in a comment."
|
|
),
|
|
"parameters": {
|
|
"type": "object",
|
|
"properties": {
|
|
"doc_token": {
|
|
"type": "string",
|
|
"description": "The document token (from the document URL or comment context).",
|
|
},
|
|
},
|
|
"required": ["doc_token"],
|
|
},
|
|
}
|
|
|
|
|
|
def _handle_feishu_doc_read(args: dict, **kwargs) -> str:
|
|
doc_token = args.get("doc_token", "").strip()
|
|
if not doc_token:
|
|
return tool_error("doc_token is required")
|
|
client = get_client()
|
|
if client is None:
|
|
return tool_error("Feishu client not available (not in a Feishu comment context)")
|
|
try:
|
|
request = build_request("GET", _RAW_CONTENT_URI, paths={"document_id": doc_token})
|
|
except ImportError:
|
|
return tool_error("lark_oapi not installed")
|
|
|
|
# Handlers run synchronously in a worker thread (no event loop): call the blocking client.
|
|
response = client.request(request)
|
|
code = getattr(response, "code", None)
|
|
if code != 0:
|
|
return tool_error(f"Failed to read document: code={code} msg={getattr(response, 'msg', 'unknown error')}")
|
|
|
|
body = raw_body(response)
|
|
if body is not None:
|
|
try:
|
|
return tool_result(success=True, content=body.get("data", {}).get("content", ""))
|
|
except AttributeError:
|
|
pass
|
|
data = getattr(response, "data", None) # fallback: the typed response.data
|
|
if data:
|
|
content = data.get("content", "") if isinstance(data, dict) else getattr(data, "content", str(data))
|
|
return tool_result(success=True, content=content)
|
|
return tool_error("No content returned from document API")
|
|
|
|
|
|
registry.register(
|
|
name="feishu_doc_read", toolset="feishu_doc", schema=FEISHU_DOC_READ_SCHEMA, handler=_handle_feishu_doc_read,
|
|
check_fn=_check_feishu, requires_env=[], is_async=False, description="Read Feishu document content",
|
|
emoji="\U0001f4c4")
|
|
|
|
|
|
# ---- BEGIN PLUGIN-COMPAT (revert-scheduled; see COMPAT_MANIFEST.md) ----
|
|
# Names external plugins imported from this module before the Sep 2026 decomposition.
|
|
# Internal code MUST NOT use these (scripts/check_compat_pointers.py fails CI if it does).
|
|
# The whole block is removed by reverting the commit that added it.
|
|
import json # noqa: F401,E402
|
|
import logging # noqa: F401,E402
|
|
import threading # noqa: F401,E402
|
|
|
|
|
|
_PLUGIN_COMPAT_LAZY = {
|
|
'logger': ('tools.approval', 'logger'),
|
|
}
|
|
|
|
|
|
def __getattr__(name): # PEP 562 — lazy so no import cycles
|
|
target = _PLUGIN_COMPAT_LAZY.get(name)
|
|
if target is None:
|
|
raise AttributeError(f"module {__name__!r} has no attribute {name!r}")
|
|
import importlib
|
|
from hermes_cli.plugin_compat import warn_once
|
|
warn_once(__name__, name, *target)
|
|
return getattr(importlib.import_module(target[0]), target[1])
|
|
# ---- END PLUGIN-COMPAT ----
|