Rename Conversation to ServerConversation and AppConfig to OpenHandsConfig (#8754)

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

openhands/core/config/__init__.py

@@ -1,5 +1,4 @@
 from openhands.core.config.agent_config import AgentConfig
-from openhands.core.config.app_config import AppConfig
 from openhands.core.config.config_utils import (
     OH_DEFAULT_AGENT,
     OH_MAX_ITERATIONS,
@@ -8,6 +7,7 @@ from openhands.core.config.config_utils import (
 from openhands.core.config.extended_config import ExtendedConfig
 from openhands.core.config.llm_config import LLMConfig
 from openhands.core.config.mcp_config import MCPConfig
+from openhands.core.config.openhands_config import OpenHandsConfig
 from openhands.core.config.sandbox_config import SandboxConfig
 from openhands.core.config.security_config import SecurityConfig
 from openhands.core.config.utils import (
@@ -15,9 +15,9 @@ from openhands.core.config.utils import (
     get_agent_config_arg,
     get_llm_config_arg,
     get_parser,
-    load_app_config,
     load_from_env,
     load_from_toml,
+    load_openhands_config,
     parse_arguments,
     setup_config_from_args,
 )
@@ -26,13 +26,13 @@ __all__ = [
     'OH_DEFAULT_AGENT',
     'OH_MAX_ITERATIONS',
     'AgentConfig',
-    'AppConfig',
+    'OpenHandsConfig',
     'MCPConfig',
     'LLMConfig',
     'SandboxConfig',
     'SecurityConfig',
     'ExtendedConfig',
-    'load_app_config',
+    'load_openhands_config',
     'load_from_env',
     'load_from_toml',
     'finalize_config',

openhands/core/config/mcp_config.py

@@ -1,10 +1,11 @@
 import os
-from urllib.parse import urlparse
 from typing import TYPE_CHECKING
+from urllib.parse import urlparse
+
 from pydantic import BaseModel, Field, ValidationError, model_validator
 
 if TYPE_CHECKING:
-    from openhands.core.config.app_config import AppConfig
+    from openhands.core.config.openhands_config import OpenHandsConfig
 
 from openhands.core.logger import openhands_logger as logger
 from openhands.utils.import_utils import get_impl
@@ -147,7 +148,7 @@ class MCPConfig(BaseModel):
 
 class OpenHandsMCPConfig:
     @staticmethod
-    def add_search_engine(app_config: "AppConfig") -> MCPStdioServerConfig | None:
+    def add_search_engine(app_config: 'OpenHandsConfig') -> MCPStdioServerConfig | None:
         """Add search engine to the MCP config"""
         if (
             app_config.search_api_key
@@ -165,17 +166,16 @@ class OpenHandsMCPConfig:
         # Do not add search engine to MCP config in SaaS mode since it will be added by the OpenHands server
         return None
 
-
     @staticmethod
     def create_default_mcp_server_config(
-        host: str, config: "AppConfig", user_id: str | None = None
+        host: str, config: 'OpenHandsConfig', user_id: str | None = None
     ) -> tuple[MCPSSEServerConfig, list[MCPStdioServerConfig]]:
         """
         Create a default MCP server configuration.
 
         Args:
             host: Host string
-            config: AppConfig
+            config: OpenHandsConfig
         Returns:
             tuple[MCPSSEServerConfig, list[MCPStdioServerConfig]]: A tuple containing the default SSE server configuration and a list of MCP stdio server configurations
         """

openhands/core/config/openhands_config.py

@@ -16,7 +16,7 @@ from openhands.core.config.sandbox_config import SandboxConfig
 from openhands.core.config.security_config import SecurityConfig
 
 
-class AppConfig(BaseModel):
+class OpenHandsConfig(BaseModel):
     """Configuration for the app.
 
     Attributes:
@@ -65,7 +65,10 @@ class AppConfig(BaseModel):
     save_trajectory_path: str | None = Field(default=None)
     save_screenshots_in_trajectory: bool = Field(default=False)
     replay_trajectory_path: str | None = Field(default=None)
-    search_api_key: SecretStr | None = Field(default=None, description="API key for Tavily search engine (https://tavily.com/). Required for search functionality.")
+    search_api_key: SecretStr | None = Field(
+        default=None,
+        description='API key for Tavily search engine (https://tavily.com/). Required for search functionality.',
+    )
 
     # Deprecated parameters - will be removed in a future version
     workspace_base: str | None = Field(default=None, deprecated=True)
@@ -73,7 +76,7 @@ class AppConfig(BaseModel):
     workspace_mount_path_in_sandbox: str = Field(default='/workspace', deprecated=True)
     workspace_mount_rewrite: str | None = Field(default=None, deprecated=True)
     # End of deprecated parameters
-    
+
     cache_dir: str = Field(default='/tmp/cache')
     run_as_openhands: bool = Field(default=True)
     max_iterations: int = Field(default=OH_MAX_ITERATIONS)
@@ -148,5 +151,5 @@ class AppConfig(BaseModel):
         """Post-initialization hook, called when the instance is created with only default values."""
         super().model_post_init(__context)
 
-        if not AppConfig.defaults_dict:  # Only set defaults_dict if it's empty
-            AppConfig.defaults_dict = model_defaults_to_dict(self)
+        if not OpenHandsConfig.defaults_dict:  # Only set defaults_dict if it's empty
+            OpenHandsConfig.defaults_dict = model_defaults_to_dict(self)

openhands/core/config/utils.py

@@ -15,7 +15,6 @@ from pydantic import BaseModel, SecretStr, ValidationError
 from openhands import __version__
 from openhands.core import logger
 from openhands.core.config.agent_config import AgentConfig
-from openhands.core.config.app_config import AppConfig
 from openhands.core.config.condenser_config import (
     CondenserConfig,
     condenser_config_from_toml_section,
@@ -28,6 +27,7 @@ from openhands.core.config.config_utils import (
 from openhands.core.config.extended_config import ExtendedConfig
 from openhands.core.config.llm_config import LLMConfig
 from openhands.core.config.mcp_config import MCPConfig
+from openhands.core.config.openhands_config import OpenHandsConfig
 from openhands.core.config.sandbox_config import SandboxConfig
 from openhands.core.config.security_config import SecurityConfig
 from openhands.storage import get_file_store
@@ -39,7 +39,7 @@ load_dotenv()
 
 
 def load_from_env(
-    cfg: AppConfig, env_or_toml_dict: dict | MutableMapping[str, str]
+    cfg: OpenHandsConfig, env_or_toml_dict: dict | MutableMapping[str, str]
 ) -> None:
     """Sets config attributes from environment variables or TOML dictionary.
 
@@ -48,7 +48,7 @@ def load_from_env(
     (e.g., AGENT_MEMORY_ENABLED), sandbox settings (e.g., SANDBOX_TIMEOUT), and more.
 
     Args:
-        cfg: The AppConfig object to set attributes on.
+        cfg: The OpenHandsConfig object to set attributes on.
         env_or_toml_dict: The environment variables or a config.toml dict.
     """
 
@@ -121,11 +121,11 @@ def load_from_env(
     set_attr_from_env(default_agent_config, 'AGENT_')
 
 
-def load_from_toml(cfg: AppConfig, toml_file: str = 'config.toml') -> None:
+def load_from_toml(cfg: OpenHandsConfig, toml_file: str = 'config.toml') -> None:
     """Load the config from the toml file. Supports both styles of config vars.
 
     Args:
-        cfg: The AppConfig object to update attributes of.
+        cfg: The OpenHandsConfig object to update attributes of.
         toml_file: The path to the toml file. Defaults to 'config.toml'.
 
     See Also:
@@ -302,7 +302,7 @@ def get_or_create_jwt_secret(file_store: FileStore) -> str:
         return new_secret
 
 
-def finalize_config(cfg: AppConfig) -> None:
+def finalize_config(cfg: OpenHandsConfig) -> None:
     """More tweaks to the config after it's been loaded."""
     # Handle the sandbox.volumes parameter
     if cfg.workspace_base is not None or cfg.workspace_mount_path is not None:
@@ -759,7 +759,7 @@ def parse_arguments() -> argparse.Namespace:
     return args
 
 
-def register_custom_agents(config: AppConfig) -> None:
+def register_custom_agents(config: OpenHandsConfig) -> None:
     """Register custom agents from configuration.
 
     This function is called after configuration is loaded to ensure all custom agents
@@ -782,16 +782,16 @@ def register_custom_agents(config: AppConfig) -> None:
                 )
 
 
-def load_app_config(
+def load_openhands_config(
     set_logging_levels: bool = True, config_file: str = 'config.toml'
-) -> AppConfig:
+) -> OpenHandsConfig:
     """Load the configuration from the specified config file and environment variables.
 
     Args:
         set_logging_levels: Whether to set the global variables for logging levels.
         config_file: Path to the config file. Defaults to 'config.toml' in the current directory.
     """
-    config = AppConfig()
+    config = OpenHandsConfig()
     load_from_toml(config, config_file)
     load_from_env(config, os.environ)
     finalize_config(config)
@@ -802,13 +802,13 @@ def load_app_config(
     return config
 
 
-def setup_config_from_args(args: argparse.Namespace) -> AppConfig:
+def setup_config_from_args(args: argparse.Namespace) -> OpenHandsConfig:
     """Load config from toml and override with command line arguments.
 
     Common setup used by both CLI and main.py entry points.
     """
     # Load base config from toml and env vars
-    config = load_app_config(config_file=args.config_file)
+    config = load_openhands_config(config_file=args.config_file)
 
     # Override with command line arguments if provided
     if args.llm_config:

openhands/core/main.py

@@ -9,7 +9,7 @@ from openhands.controller.agent import Agent
 from openhands.controller.replay import ReplayManager
 from openhands.controller.state.state import State
 from openhands.core.config import (
-    AppConfig,
+    OpenHandsConfig,
     parse_arguments,
     setup_config_from_args,
 )
@@ -47,7 +47,7 @@ class FakeUserResponseFunc(Protocol):
 
 
 async def run_controller(
-    config: AppConfig,
+    config: OpenHandsConfig,
     initial_user_action: Action,
     sid: str | None = None,
     runtime: Runtime | None = None,
@@ -90,7 +90,7 @@ async def run_controller(
           config.max_budget_per_task.
 
     Example:
-        >>> config = load_app_config()
+        >>> config = load_openhands_config()
         >>> action = MessageAction(content="Write a hello world program")
         >>> state = await run_controller(config=config, initial_user_action=action)
     """
@@ -279,7 +279,7 @@ def load_replay_log(trajectory_path: str) -> tuple[list[Event] | None, Action]:
 if __name__ == '__main__':
     args = parse_arguments()
 
-    config: AppConfig = setup_config_from_args(args)
+    config: OpenHandsConfig = setup_config_from_args(args)
 
     # Read task from file, CLI args, or stdin
     task_str = read_task(args, config.cli_multiline_input)

openhands/core/setup.py

@@ -10,7 +10,7 @@ from openhands.controller import AgentController
 from openhands.controller.agent import Agent
 from openhands.controller.state.state import State
 from openhands.core.config import (
-    AppConfig,
+    OpenHandsConfig,
 )
 from openhands.core.logger import openhands_logger as logger
 from openhands.events import EventStream
@@ -28,7 +28,7 @@ from openhands.utils.async_utils import GENERAL_TIMEOUT, call_async_from_sync
 
 
 def create_runtime(
-    config: AppConfig,
+    config: OpenHandsConfig,
     sid: str | None = None,
     headless_mode: bool = True,
     agent: Agent | None = None,
@@ -172,7 +172,7 @@ def create_memory(
     return memory
 
 
-def create_agent(config: AppConfig) -> Agent:
+def create_agent(config: OpenHandsConfig) -> Agent:
     agent_cls: type[Agent] = Agent.get_cls(config.default_agent)
     agent_config = config.get_agent_config(config.default_agent)
     llm_config = config.get_llm_config_from_agent(config.default_agent)
@@ -188,7 +188,7 @@ def create_agent(config: AppConfig) -> Agent:
 def create_controller(
     agent: Agent,
     runtime: Runtime,
-    config: AppConfig,
+    config: OpenHandsConfig,
     headless_mode: bool = True,
     replay_events: list[Event] | None = None,
 ) -> tuple[AgentController, State | None]:
@@ -218,7 +218,7 @@ def create_controller(
     return (controller, initial_state)
 
 
-def generate_sid(config: AppConfig, session_name: str | None = None) -> str:
+def generate_sid(config: OpenHandsConfig, session_name: str | None = None) -> str:
     """Generate a session id based on the session name and the jwt secret."""
     session_name = session_name or str(uuid.uuid4())
     jwt_secret = config.jwt_secret