Files
hermes-agent/tools/open_preview_tool.py
T
Teknium 2776813df3 compat(plugins): temporary import-path shims for external plugins — ONE commit, revert on schedule
The Sep 2026 decomposition (PR #102117) makes internal import paths a non-API: names now live in
the focused modules that define them. This commit is the ONLY thing keeping the old paths alive,
so external plugins have time to update. It is deliberately a single, unsquashed commit:

    git revert <this sha>

removes every shim, stub and manifest at once on the announced date. Nothing in-tree may depend on
these pointers: scripts/check_compat_pointers.py (wired into lint.yml) fails CI if it does.

What it adds (see COMPAT_MANIFEST.md, compat_manifest.json):
- 332 facade modules get one delimited `PLUGIN-COMPAT` block appended at the end of the file
- 1,172 moved names resolved lazily via a module `__getattr__` (PEP 562) — never a top-level import,
  so no import cycles; facades that already had `__getattr__` get a chained one
- 592 third-party/stdlib names the old modules used to expose, with their original import statements
- 266 public definitions that had been deleted as unused, restored byte-for-byte from the pre-decomposition
  tree (+40 private helpers and 16 imports pulled in only because a restored definition needs them)
- 3 deleted modules recreated as re-export stubs (gateway/startup_watchdog, hermes_cli/observability/
  relay_runtime, tools/environments/modal_utils)
- private names (`_x`) get no pointer: they were never API (3,792 skipped)

Verified: all 335 touched modules import under a fresh HERMES_HOME and every manifest name resolves;
the lint reports zero in-tree uses; ruff clean; targeted suites unchanged.
2026-09-03 17:13:22 -07:00

96 lines
3.7 KiB
Python

#!/usr/bin/env python3
"""Open a URL, dev server, or file in the Hermes desktop GUI's preview pane.
Registration lives in the `desktop_preview` tool (``tools.preview_tool``); this module keeps
the normalizer + open action. Emits ``preview.open`` via ``desktop_ui``: the renderer opens
the pane for the window that asked and never steals focus for a background session.
"""
import re
from tools import desktop_ui
from tools.registry import tool_error
def _normalize_target(raw: str) -> str:
"""Coax a bare host/domain into a fetchable URL; leave paths + schemes alone.
``www.cnn.com`` -> ``https://www.cnn.com``; ``localhost:3000`` -> ``http://localhost:3000``.
File paths and explicit schemes pass through for the renderer's preview normalizer.
"""
v = raw.strip().strip("`").strip()
if not v or "://" in v or v.startswith(("/", "./", "../", "~", "file:")):
return v
if re.match(r"^(localhost|127\.0\.0\.1|0\.0\.0\.0|\[::1\])(:\d+)?(/|$)", v, re.I):
return "http://" + v
if re.match(r"^[\w.-]+\.[a-z]{2,}(:\d+)?(/.*)?$", v, re.I):
return "https://" + v
return v
def open_preview_tool(url: str, label: str = "") -> str:
"""Ask the desktop GUI to show ``url`` in the preview pane beside the chat."""
target = _normalize_target(url or "")
if not target:
return tool_error(
"url is required — a web URL (https://…), a localhost dev server, or a "
"file path to show in the preview pane.")
label = (label or "").strip()
return desktop_ui.emit_or_error(
"preview.open",
{"url": target, "label": label},
"Failed to open the preview pane: ",
"The preview pane is only available in the Hermes desktop app.",
{"success": True, "url": target, "label": label})
# ---- 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
OPEN_PREVIEW_SCHEMA = {
"name": "open_preview",
"description": (
"Open something in the preview pane beside the chat in the Hermes desktop "
"app. Use this when the user asks to see a page, dev server, or file in the "
"preview pane — e.g. \"open cnn.com in the preview pane\" or \"preview "
"localhost:3000\". Accepts a web URL (a bare domain like www.cnn.com is fine), "
"a localhost dev-server URL, or a file path (HTML renders live; other files "
"show their contents). The pane opens for the current window only. To close "
"the pane or a tab, use close_preview."
),
"parameters": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": (
"What to preview: a web URL (https://… or a bare domain), a "
"localhost URL (localhost:3000), or a file path."
),
},
"label": {
"type": "string",
"description": "Optional tab label; defaults to the target's name.",
},
},
"required": ["url"],
},
}
_PLUGIN_COMPAT_LAZY = {
'registry': ('tools.registry', 'registry'),
}
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
return getattr(importlib.import_module(target[0]), target[1])
# ---- END PLUGIN-COMPAT ----