Add auto-formatting with ruff format to CI

- Split ruff pre-commit hook into separate format and check steps
- Add auto-commit functionality to CI for formatting changes
- Ensures consistent code formatting across all PRs
- Auto-formatted existing code with new ruff format settings

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

Author: openhands-agent

.github/workflows/precommit.yml

@@ -4,6 +4,12 @@ name: Pre-commit checks
 on:
   push:
     branches: ["**"]   # all branches
+  pull_request:
+    branches: ["**"]
+
+permissions:
+  contents: write
+  pull-requests: write
 
 jobs:
   pre-commit:
@@ -12,6 +18,9 @@ jobs:
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          fetch-depth: 0
 
       - name: Set up Python
         uses: actions/setup-python@v5
@@ -28,3 +37,10 @@ jobs:
         uses: pre-commit/action@v3.0.1
         with:
           extra_args: --all-files
+
+      - name: Auto-commit formatting changes
+        if: failure()
+        uses: stefanzweifel/git-auto-commit-action@v5
+        with:
+          commit_message: "Auto-format code with ruff\n\nCo-authored-by: openhands <openhands@all-hands.dev>"
+          file_pattern: "*.py"

.openhands/setup.sh

@@ -1,8 +1,16 @@
 repos:
   - repo: local
     hooks:
-      - id: ruff
-        name: Ruff (format + lint)
+      - id: ruff-format
+        name: Ruff format
+        entry: uv
+        args: [run, ruff, format]
+        language: system
+        types: [python]
+        pass_filenames: false
+        always_run: true
+      - id: ruff-check
+        name: Ruff lint
         entry: uv
         args: [run, ruff, check, --fix, --exit-non-zero-on-fix]
         language: system

.pre-commit-config.yaml

@@ -35,12 +35,7 @@ def __init__(
             assert tool not in tools, f"{tool} is automatically included and should not be provided."
         super().__init__(llm=llm, tools=tools + BUILT_IN_TOOLS, env_context=env_context)
 
-        self.system_message: TextContent = TextContent(
-            text=render_system_message(
-            prompt_dir=self.prompt_dir,
-            system_prompt_filename=system_prompt_filename,
-            cli_mode=cli_mode
-        ))
+        self.system_message: TextContent = TextContent(text=render_system_message(prompt_dir=self.prompt_dir, system_prompt_filename=system_prompt_filename, cli_mode=cli_mode))
 
         self.max_iterations: int = 10
 

openhands/core/agent/codeact_agent/codeact_agent.py

@@ -17,21 +17,4 @@
 from .utils import render_additional_info, render_initial_user_message, render_microagent_info, render_system_message
 
 
-__all__ = [
-    "EnvContext",
-    "RepositoryInfo",
-    "RuntimeInfo",
-    "ConversationInstructions",
-    "MessageContext",
-    "BaseMicroagent",
-    "KnowledgeMicroagent",
-    "RepoMicroagent",
-    "MicroagentMetadata",
-    "MicroagentType",
-    "MicroagentKnowledge",
-    "load_microagents_from_dir",
-    "render_system_message",
-    "render_initial_user_message",
-    "render_additional_info",
-    "render_microagent_info"
-]
+__all__ = ["EnvContext", "RepositoryInfo", "RuntimeInfo", "ConversationInstructions", "MessageContext", "BaseMicroagent", "KnowledgeMicroagent", "RepoMicroagent", "MicroagentMetadata", "MicroagentType", "MicroagentKnowledge", "load_microagents_from_dir", "render_system_message", "render_initial_user_message", "render_additional_info", "render_microagent_info"]

openhands/core/context/__init__.py

@@ -1,4 +1,3 @@
-
 from pydantic import BaseModel, Field
 
 from openhands.core.context.utils.prompt import render_microagent_info

openhands/core/context/env_context.py

@@ -26,15 +26,13 @@ class BaseMicroagent(BaseModel):
     type: MicroagentType
 
     PATH_TO_THIRD_PARTY_MICROAGENT_NAME: ClassVar[dict[str, str]] = {
-        '.cursorrules': 'cursorrules',
-        'agents.md': 'agents',
-        'agent.md': 'agents',
+        ".cursorrules": "cursorrules",
+        "agents.md": "agents",
+        "agent.md": "agents",
     }
 
     @classmethod
-    def _handle_third_party(
-        cls, path: Path, file_content: str
-    ) -> Union['RepoMicroagent', None]:
+    def _handle_third_party(cls, path: Path, file_content: str) -> Union["RepoMicroagent", None]:
         # Determine the agent name based on file type
         microagent_name = cls.PATH_TO_THIRD_PARTY_MICROAGENT_NAME.get(path.name.lower())
 
@@ -56,7 +54,7 @@ def load(
         path: Union[str, Path],
         microagent_dir: Path | None = None,
         file_content: str | None = None,
-    ) -> 'BaseMicroagent':
+    ) -> "BaseMicroagent":
         """Load a microagent from a markdown file with frontmatter.
 
         The agent's name is derived from its path relative to the microagent_dir.
@@ -68,21 +66,19 @@ def load(
         derived_name = None
         if microagent_dir is not None:
             # Special handling for files which are not in microagent_dir
-            derived_name = cls.PATH_TO_THIRD_PARTY_MICROAGENT_NAME.get(
-                path.name.lower()
-            ) or str(path.relative_to(microagent_dir).with_suffix(''))
+            derived_name = cls.PATH_TO_THIRD_PARTY_MICROAGENT_NAME.get(path.name.lower()) or str(path.relative_to(microagent_dir).with_suffix(""))
 
         # Only load directly from path if file_content is not provided
         if file_content is None:
             with open(path) as f:
                 file_content = f.read()
 
         # Legacy repo instructions are stored in .openhands_instructions
-        if path.name == '.openhands_instructions':
+        if path.name == ".openhands_instructions":
             return RepoMicroagent(
-                name='repo_legacy',
+                name="repo_legacy",
                 content=file_content,
-                metadata=MicroagentMetadata(name='repo_legacy'),
+                metadata=MicroagentMetadata(name="repo_legacy"),
                 source=str(path),
                 type=MicroagentType.REPO_KNOWLEDGE,
             )
@@ -100,31 +96,24 @@ def load(
         metadata_dict = loaded.metadata or {}
 
         # Ensure version is always a string (YAML may parse numeric versions as integers)
-        if 'version' in metadata_dict and not isinstance(metadata_dict['version'], str):
-            metadata_dict['version'] = str(metadata_dict['version'])
+        if "version" in metadata_dict and not isinstance(metadata_dict["version"], str):
+            metadata_dict["version"] = str(metadata_dict["version"])
 
         try:
             metadata = MicroagentMetadata.model_validate(metadata_dict)
 
             # Validate MCP tools configuration if present
             if metadata.mcp_tools:
                 if metadata.mcp_tools.sse_servers:
-                    logger.warning(
-                        f'Microagent {metadata.name} has SSE servers. Only stdio servers are currently supported.'
-                    )
+                    logger.warning(f"Microagent {metadata.name} has SSE servers. Only stdio servers are currently supported.")
 
                 if not metadata.mcp_tools.stdio_servers:
-                    raise MicroagentValidationError(
-                        f'Microagent {metadata.name} has MCP tools configuration but no stdio servers. '
-                        'Only stdio servers are currently supported.'
-                    )
+                    raise MicroagentValidationError(f"Microagent {metadata.name} has MCP tools configuration but no stdio servers. Only stdio servers are currently supported.")
         except Exception as e:
             # Provide more detailed error message for validation errors
-            error_msg = f'Error validating microagent metadata in {path.name}: {str(e)}'
-            if 'type' in metadata_dict and metadata_dict['type'] not in [
-                t.value for t in MicroagentType
-            ]:
-                valid_types = ', '.join([f'"{t.value}"' for t in MicroagentType])
+            error_msg = f"Error validating microagent metadata in {path.name}: {str(e)}"
+            if "type" in metadata_dict and metadata_dict["type"] not in [t.value for t in MicroagentType]:
+                valid_types = ", ".join([f'"{t.value}"' for t in MicroagentType])
                 error_msg += f'. Invalid "type" value: "{metadata_dict["type"]}". Valid types are: {valid_types}'
             raise MicroagentValidationError(error_msg) from e
 
@@ -143,7 +132,7 @@ def load(
         if metadata.inputs:
             inferred_type = MicroagentType.TASK
             # Add a trigger for the agent name if not already present
-            trigger = f'/{metadata.name}'
+            trigger = f"/{metadata.name}"
             if not metadata.triggers or trigger not in metadata.triggers:
                 if not metadata.triggers:
                     metadata.triggers = [trigger]
@@ -158,7 +147,7 @@ def load(
 
         if inferred_type not in subclass_map:
             # This should theoretically not happen with the logic above
-            raise ValueError(f'Could not determine microagent type for: {path}')
+            raise ValueError(f"Could not determine microagent type for: {path}")
 
         # Use derived_name if available (from relative path), otherwise fallback to metadata.name
         agent_name = derived_name if derived_name is not None else metadata.name
@@ -186,7 +175,7 @@ class KnowledgeMicroagent(BaseMicroagent):
     def __init__(self, **data):
         super().__init__(**data)
         if self.type not in [MicroagentType.KNOWLEDGE, MicroagentType.TASK]:
-            raise ValueError('KnowledgeMicroagent must have type KNOWLEDGE or TASK')
+            raise ValueError("KnowledgeMicroagent must have type KNOWLEDGE or TASK")
 
     def match_trigger(self, message: str) -> str | None:
         """Match a trigger in the message.
@@ -220,9 +209,7 @@ class RepoMicroagent(BaseMicroagent):
     def __init__(self, **data):
         super().__init__(**data)
         if self.type != MicroagentType.REPO_KNOWLEDGE:
-            raise ValueError(
-                f'RepoMicroagent initialized with incorrect type: {self.type}'
-            )
+            raise ValueError(f"RepoMicroagent initialized with incorrect type: {self.type}")
 
 
 class TaskMicroagent(KnowledgeMicroagent):
@@ -235,9 +222,7 @@ class TaskMicroagent(KnowledgeMicroagent):
     def __init__(self, **data):
         super().__init__(**data)
         if self.type != MicroagentType.TASK:
-            raise ValueError(
-                f'TaskMicroagent initialized with incorrect type: {self.type}'
-            )
+            raise ValueError(f"TaskMicroagent initialized with incorrect type: {self.type}")
 
         # Append a prompt to ask for missing variables
         self._append_missing_variables_prompt()
@@ -256,7 +241,7 @@ def extract_variables(self, content: str) -> list[str]:
 
         Variables are in the format ${variable_name}.
         """
-        pattern = r'\$\{([a-zA-Z_][a-zA-Z0-9_]*)\}'
+        pattern = r"\$\{([a-zA-Z_][a-zA-Z0-9_]*)\}"
         matches = re.findall(pattern, content)
         return matches
 
@@ -267,7 +252,7 @@ def requires_user_input(self) -> bool:
         """
         # Check if the content contains any variables
         variables = self.extract_variables(self.content)
-        logger.debug(f'This microagent requires user input: {variables}')
+        logger.debug(f"This microagent requires user input: {variables}")
         return len(variables) > 0
 
     @property
@@ -296,18 +281,18 @@ def load_microagents_from_dir(
     knowledge_agents = {}
 
     # Load all agents from microagents directory
-    logger.debug(f'Loading agents from {microagent_dir}')
+    logger.debug(f"Loading agents from {microagent_dir}")
 
     # Always check for .cursorrules and AGENTS.md files in repo root, regardless of whether microagents_dir exists
     special_files = []
     repo_root = microagent_dir.parent.parent
 
     # Check for .cursorrules
-    if (repo_root / '.cursorrules').exists():
-        special_files.append(repo_root / '.cursorrules')
+    if (repo_root / ".cursorrules").exists():
+        special_files.append(repo_root / ".cursorrules")
 
     # Check for AGENTS.md (case-insensitive)
-    for agents_filename in ['AGENTS.md', 'agents.md', 'AGENT.md', 'agent.md']:
+    for agents_filename in ["AGENTS.md", "agents.md", "AGENT.md", "agent.md"]:
         agents_path = repo_root / agents_filename
         if agents_path.exists():
             special_files.append(agents_path)
@@ -316,7 +301,7 @@ def load_microagents_from_dir(
     # Collect .md files from microagents directory if it exists
     md_files = []
     if microagent_dir.exists():
-        md_files = [f for f in microagent_dir.rglob('*.md') if f.name != 'README.md']
+        md_files = [f for f in microagent_dir.rglob("*.md") if f.name != "README.md"]
 
     # Process all files in one loop
     for file in chain(special_files, md_files):
@@ -329,15 +314,12 @@ def load_microagents_from_dir(
                 knowledge_agents[agent.name] = agent
         except MicroagentValidationError as e:
             # For validation errors, include the original exception
-            error_msg = f'Error loading microagent from {file}: {str(e)}'
+            error_msg = f"Error loading microagent from {file}: {str(e)}"
             raise MicroagentValidationError(error_msg) from e
         except Exception as e:
             # For other errors, wrap in a ValueError with detailed message
-            error_msg = f'Error loading microagent from {file}: {str(e)}'
+            error_msg = f"Error loading microagent from {file}: {str(e)}"
             raise ValueError(error_msg) from e
 
-    logger.debug(
-        f'Loaded {len(repo_agents) + len(knowledge_agents)} microagents: '
-        f'{[*repo_agents.keys(), *knowledge_agents.keys()]}'
-    )
+    logger.debug(f"Loaded {len(repo_agents) + len(knowledge_agents)} microagents: {[*repo_agents.keys(), *knowledge_agents.keys()]}")
     return repo_agents, knowledge_agents

openhands/core/context/microagents/microagent.py

@@ -13,6 +13,7 @@ def refine(text: str) -> str:
         text = re.sub(r"(?<!execute_)(?<!_)\bbash\b", "powershell", text, flags=re.IGNORECASE)
     return text
 
+
 @lru_cache(maxsize=64)
 def _get_env(prompt_dir: str) -> Environment:
     if not prompt_dir:
@@ -30,6 +31,7 @@ def _get_env(prompt_dir: str) -> Environment:
     env.filters["refine"] = refine
     return env
 
+
 @lru_cache(maxsize=256)
 def _get_template(prompt_dir: str, template_name: str) -> Template:
     env = _get_env(prompt_dir)
@@ -38,19 +40,24 @@ def _get_template(prompt_dir: str, template_name: str) -> Template:
     except Exception:
         raise FileNotFoundError(f"Prompt file {os.path.join(prompt_dir, template_name)} not found")
 
+
 def render_template(prompt_dir: str, template_name: str, **ctx) -> str:
     tpl = _get_template(prompt_dir, template_name)
     return refine(tpl.render(**ctx).strip())
 
+
 # Convenience wrappers keeping old names/semantics
 def render_system_message(prompt_dir: str, system_prompt_filename: str = "system_prompt.j2", **ctx) -> str:
     return render_template(prompt_dir, system_prompt_filename, **ctx)
 
+
 def render_initial_user_message(prompt_dir: str, **ctx) -> str:
     return render_template(prompt_dir, "user_prompt.j2", **ctx)
 
+
 def render_additional_info(prompt_dir: str, **ctx) -> str:
     return render_template(prompt_dir, "additional_info.j2", **ctx)
 
+
 def render_microagent_info(prompt_dir: str, **ctx) -> str:
     return render_template(prompt_dir, "microagent_info.j2", **ctx)

openhands/core/context/utils/prompt.py

@@ -15,6 +15,7 @@
 
 N_CHAR_PREVIEW = 500
 
+
 class EventBase(BaseModel, ABC):
     """Base class for all events."""
 
@@ -56,7 +57,7 @@ def __str__(self) -> str:
                 content_preview = " ".join(text_parts)
                 # Truncate long content for display
                 if len(content_preview) > N_CHAR_PREVIEW:
-                    content_preview = content_preview[:N_CHAR_PREVIEW-3] + "..."
+                    content_preview = content_preview[: N_CHAR_PREVIEW - 3] + "..."
                 return f"{base_str}\n  {llm_message.role}: {content_preview}"
             else:
                 return f"{base_str}\n  {llm_message.role}: [no text content]"

openhands/core/event/base.py

@@ -102,7 +102,7 @@ def __str__(self) -> str:
         if text_parts:
             content_preview = " ".join(text_parts)
             if len(content_preview) > N_CHAR_PREVIEW:
-                content_preview = content_preview[:N_CHAR_PREVIEW-3] + "..."
+                content_preview = content_preview[: N_CHAR_PREVIEW - 3] + "..."
             microagent_info = f" [Microagents: {', '.join(self.activated_microagents)}]" if self.activated_microagents else ""
             return f"{base_str}\n  {self.llm_message.role}: {content_preview}{microagent_info}"
         else: