Port over file editor tool (#2)

Co-authored-by: openhands <openhands@all-hands.dev>

Author: xingyaoww

.github/workflows/precommit.yml

@@ -0,0 +1,30 @@
+# .github/workflows/precommit.yml
+name: Pre-commit checks
+
+on:
+  push:
+    branches: ["**"]   # all branches
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+
+      - name: Install dependencies
+        run: uv sync --frozen
+
+      - name: Run pre-commit (all files)
+        uses: pre-commit/action@v3.0.1
+        with:
+          extra_args: --all-files

.github/workflows/tests.yml

@@ -0,0 +1,28 @@
+name: Run tests
+on:
+  push:
+    branches: ["**"]
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+
+      - name: Install dependencies
+        run: uv sync --frozen --group dev
+
+      - name: Install project (editable)
+        run: uv pip install -e .
+
+      - name: Run pytest
+        run: uv run pytest -v tests/

.pre-commit-config.yaml

@@ -17,3 +17,11 @@ repos:
         types: [python]
         pass_filenames: false
         always_run: true
+      - id: pyright
+        name: Type check with Pyright (strict)
+        entry: uv
+        args: [run, pyright]
+        language: system
+        types: [python]
+        pass_filenames: false
+        always_run: true

openhands/__init__.py

@@ -0,0 +1 @@
+"""OpenHands package."""

openhands/core/__init__.py

@@ -0,0 +1,83 @@
+# simple_logger.py
+"""
+Minimal logger setup that encourages per-module loggers.
+
+Usage:
+    from openhands.core.logger import get_logger
+    logger = get_logger(__name__)
+    logger.info("Hello from this module!")
+"""
+
+import logging
+import os
+from logging.handlers import TimedRotatingFileHandler
+
+# ========= ENV (loaded at import) =========
+LEVEL_MAP = (
+    logging.getLevelNamesMapping()
+    if hasattr(logging, "getLevelNamesMapping")
+    else logging._nameToLevel
+)
+
+ENV_LOG_LEVEL_STR = os.getenv("LOG_LEVEL", "INFO").upper()
+ENV_LOG_LEVEL = LEVEL_MAP.get(ENV_LOG_LEVEL_STR, logging.INFO)
+ENV_LOG_TO_FILE = os.getenv("LOG_TO_FILE", "false").lower() in {"1", "true", "yes"}
+ENV_LOG_DIR = os.getenv("LOG_DIR", "logs")
+ENV_ROTATE_WHEN = os.getenv("LOG_ROTATE_WHEN", "midnight")
+ENV_BACKUP_COUNT = int(os.getenv("LOG_BACKUP_COUNT", "7"))
+ENV_FORMAT = os.getenv(
+    "LOG_FORMAT",
+    "%(asctime)s | %(levelname)s | %(name)s | %(pathname)s:%(lineno)d | %(message)s",
+)
+ENV_AUTO_CONFIG = os.getenv("LOG_AUTO_CONFIG", "true").lower() in {"1", "true", "yes"}
+
+
+# ========= SETUP =========
+def setup_logging(
+    level: int | None = None,
+    log_to_file: bool | None = None,
+    log_dir: str | None = None,
+    fmt: str | None = None,
+    when: str | None = None,
+    backup_count: int | None = None,
+) -> None:
+    """Configure the root logger. All child loggers inherit this setup."""
+    lvl = ENV_LOG_LEVEL if level is None else level
+    to_file = ENV_LOG_TO_FILE if log_to_file is None else log_to_file
+    directory = ENV_LOG_DIR if log_dir is None else log_dir
+    format_str = ENV_FORMAT if fmt is None else fmt
+    rotate_when = ENV_ROTATE_WHEN if when is None else when
+    keep = ENV_BACKUP_COUNT if backup_count is None else backup_count
+
+    root = logging.getLogger()
+    root.setLevel(lvl)
+    root.handlers = []  # reset
+
+    formatter = logging.Formatter(format_str)
+
+    ch = logging.StreamHandler()
+    ch.setLevel(lvl)
+    ch.setFormatter(formatter)
+    root.addHandler(ch)
+
+    if to_file:
+        os.makedirs(directory, exist_ok=True)
+        fh = TimedRotatingFileHandler(
+            os.path.join(directory, "app.log"),
+            when=rotate_when,
+            backupCount=keep,
+            encoding="utf-8",
+        )
+        fh.setLevel(lvl)
+        fh.setFormatter(formatter)
+        root.addHandler(fh)
+
+
+def get_logger(name: str) -> logging.Logger:
+    """Return a logger for the given module name."""
+    return logging.getLogger(name)
+
+
+# Auto-configure if desired
+if ENV_AUTO_CONFIG:
+    setup_logging()

openhands/core/logger.py

@@ -0,0 +1 @@
+"""OpenHands runtime package."""

openhands/core/runtime/__init__.py

@@ -0,0 +1,4 @@
+from typing import Literal
+
+SECURITY_RISK_DESC = "The LLM's assessment of the safety risk of this action."
+SECURITY_RISK_LITERAL = Literal["LOW", "MEDIUM", "HIGH"]

openhands/runtime/schema.py renamed to openhands/core/runtime/schema.py

@@ -1,14 +1,33 @@
 from typing import Any, Callable
-from pydantic import BaseModel
+from pydantic import BaseModel, Field
 from .schema import ActionBase, ObservationBase, Schema
 
 
 class ToolAnnotations(BaseModel):
-    title: str | None = None
-    readOnlyHint: bool | None = None
-    destructiveHint: bool | None = None
-    idempotentHint: bool | None = None
-    openWorldHint: bool | None = None
+    """Annotations to provide hints about the tool's behavior.
+
+    Based on Model Context Protocol (MCP) spec: https://github.com/modelcontextprotocol/modelcontextprotocol/blob/caf3424488b10b4a7b1f8cb634244a450a1f4400/schema/2025-06-18/schema.ts#L838
+    """
+
+    title: str | None = Field(
+        default=None, description="A human-readable title for the tool."
+    )
+    readOnlyHint: bool = Field(
+        default=False,
+        description="If true, the tool does not modify its environment. Default: false",
+    )
+    destructiveHint: bool = Field(
+        default=True,
+        description="If true, the tool may perform destructive updates to its environment. If false, the tool performs only additive updates. (This property is meaningful only when `readOnlyHint == false`) Default: true",
+    )
+    idempotentHint: bool = Field(
+        default=False,
+        description="If true, calling the tool repeatedly with the same arguments will have no additional effect on the its environment. (This property is meaningful only when `readOnlyHint == false`) Default: false",
+    )
+    openWorldHint: bool = Field(
+        default=True,
+        description="If true, this tool may interact with an 'open world' of external entities. If false, the tool's domain of interaction is closed. For example, the world of a web search tool is open, whereas that of a memory tool is not. Default: true",
+    )
 
 
 class Tool: