d0ffb111c2
Comprehensive cleanup across 80 files based on automated (ruff, pyflakes, vulture)
and manual analysis of the entire codebase.
Changes by category:
Unused imports removed (~95 across 55 files):
- Removed genuinely unused imports from all major subsystems
- agent/, hermes_cli/, tools/, gateway/, plugins/, cron/
- Includes imports in try/except blocks that were truly unused
(vs availability checks which were left alone)
Unused variables removed (~25):
- Removed dead variables: connected, inner, channels, last_exc,
source, new_server_names, verify, pconfig, default_terminal,
result, pending_handled, temperature, loop
- Dropped unused argparse subparser assignments in hermes_cli/main.py
(12 instances of add_parser() where result was never used)
Dead code removed:
- run_agent.py: Removed dead ternary (None if False else None) and
surrounding unreachable branch in identity fallback
- run_agent.py: Removed write-only attribute _last_reported_tool
- hermes_cli/providers.py: Removed dead @property decorator on
module-level function (decorator has no effect outside a class)
- gateway/run.py: Removed unused MCP config load before reconnect
- gateway/platforms/slack.py: Removed dead SessionSource construction
Undefined name bugs fixed (would cause NameError at runtime):
- batch_runner.py: Added missing logger = logging.getLogger(__name__)
- tools/environments/daytona.py: Added missing Dict and Path imports
Unnecessary global statements removed (14):
- tools/terminal_tool.py: 5 functions declared global for dicts
they only mutated via .pop()/[key]=value (no rebinding)
- tools/browser_tool.py: cleanup thread loop only reads flag
- tools/rl_training_tool.py: 4 functions only do dict mutations
- tools/mcp_oauth.py: only reads the global
- hermes_time.py: only reads cached values
Inefficient patterns fixed:
- startswith/endswith tuple form: 15 instances of
x.startswith('a') or x.startswith('b') consolidated to
x.startswith(('a', 'b'))
- len(x)==0 / len(x)>0: 13 instances replaced with pythonic
truthiness checks (not x / bool(x))
- in dict.keys(): 5 instances simplified to in dict
- Redefined unused name: removed duplicate _strip_mdv2 import in
send_message_tool.py
Other fixes:
- hermes_cli/doctor.py: Replaced undefined logger.debug() with pass
- hermes_cli/config.py: Consolidated chained .endswith() calls
Test results: 3934 passed, 17 failed (all pre-existing on main),
19 skipped. Zero regressions.
106 lines
3.6 KiB
Python
106 lines
3.6 KiB
Python
"""Shared debug session infrastructure for Hermes tools.
|
|
|
|
Replaces the identical DEBUG_MODE / _log_debug_call / _save_debug_log /
|
|
get_debug_session_info boilerplate previously duplicated across web_tools,
|
|
vision_tools, mixture_of_agents_tool, and image_generation_tool.
|
|
|
|
Usage in a tool module:
|
|
|
|
from tools.debug_helpers import DebugSession
|
|
|
|
_debug = DebugSession("web_tools", env_var="WEB_TOOLS_DEBUG")
|
|
|
|
# Log a call (no-op when debug mode is off)
|
|
_debug.log_call("web_search", {"query": q, "results": len(r)})
|
|
|
|
# Save the debug log (no-op when debug mode is off)
|
|
_debug.save()
|
|
|
|
# Expose debug info to external callers
|
|
def get_debug_session_info():
|
|
return _debug.get_session_info()
|
|
"""
|
|
|
|
import datetime
|
|
import json
|
|
import logging
|
|
import os
|
|
import uuid
|
|
from typing import Any, Dict
|
|
|
|
from hermes_constants import get_hermes_home
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
class DebugSession:
|
|
"""Per-tool debug session that records tool calls to a JSON log file.
|
|
|
|
Activated by a tool-specific environment variable (e.g. WEB_TOOLS_DEBUG=true).
|
|
When disabled, all methods are cheap no-ops.
|
|
"""
|
|
|
|
def __init__(self, tool_name: str, *, env_var: str) -> None:
|
|
self.tool_name = tool_name
|
|
self.enabled = os.getenv(env_var, "false").lower() == "true"
|
|
self.session_id = str(uuid.uuid4()) if self.enabled else ""
|
|
self.log_dir = get_hermes_home() / "logs"
|
|
self._calls: list[Dict[str, Any]] = []
|
|
self._start_time = datetime.datetime.now().isoformat() if self.enabled else ""
|
|
|
|
if self.enabled:
|
|
self.log_dir.mkdir(parents=True, exist_ok=True)
|
|
logger.debug("%s debug mode enabled - Session ID: %s",
|
|
tool_name, self.session_id)
|
|
|
|
@property
|
|
def active(self) -> bool:
|
|
return self.enabled
|
|
|
|
def log_call(self, call_name: str, call_data: Dict[str, Any]) -> None:
|
|
"""Append a tool-call entry to the in-memory log."""
|
|
if not self.enabled:
|
|
return
|
|
self._calls.append({
|
|
"timestamp": datetime.datetime.now().isoformat(),
|
|
"tool_name": call_name,
|
|
**call_data,
|
|
})
|
|
|
|
def save(self) -> None:
|
|
"""Flush the in-memory log to a JSON file in the logs directory."""
|
|
if not self.enabled:
|
|
return
|
|
try:
|
|
filename = f"{self.tool_name}_debug_{self.session_id}.json"
|
|
filepath = self.log_dir / filename
|
|
payload = {
|
|
"session_id": self.session_id,
|
|
"start_time": self._start_time,
|
|
"end_time": datetime.datetime.now().isoformat(),
|
|
"debug_enabled": True,
|
|
"total_calls": len(self._calls),
|
|
"tool_calls": self._calls,
|
|
}
|
|
with open(filepath, "w", encoding="utf-8") as f:
|
|
json.dump(payload, f, indent=2, ensure_ascii=False)
|
|
logger.debug("%s debug log saved: %s", self.tool_name, filepath)
|
|
except Exception as e:
|
|
logger.error("Error saving %s debug log: %s", self.tool_name, e)
|
|
|
|
def get_session_info(self) -> Dict[str, Any]:
|
|
"""Return a summary dict suitable for returning from get_debug_session_info()."""
|
|
if not self.enabled:
|
|
return {
|
|
"enabled": False,
|
|
"session_id": None,
|
|
"log_path": None,
|
|
"total_calls": 0,
|
|
}
|
|
return {
|
|
"enabled": True,
|
|
"session_id": self.session_id,
|
|
"log_path": str(self.log_dir / f"{self.tool_name}_debug_{self.session_id}.json"),
|
|
"total_calls": len(self._calls),
|
|
}
|