aboutsummaryrefslogtreecommitdiff
path: root/autogpts/autogpt/autogpt/agents/features/file_workspace.py
diff options
context:
space:
mode:
Diffstat (limited to 'autogpts/autogpt/autogpt/agents/features/file_workspace.py')
-rw-r--r--autogpts/autogpt/autogpt/agents/features/file_workspace.py65
1 files changed, 65 insertions, 0 deletions
diff --git a/autogpts/autogpt/autogpt/agents/features/file_workspace.py b/autogpts/autogpt/autogpt/agents/features/file_workspace.py
new file mode 100644
index 000000000..22ab8119d
--- /dev/null
+++ b/autogpts/autogpt/autogpt/agents/features/file_workspace.py
@@ -0,0 +1,65 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+ from pathlib import Path
+
+ from ..base import BaseAgent, Config
+
+from autogpt.file_workspace import (
+ FileWorkspace,
+ FileWorkspaceBackendName,
+ get_workspace,
+)
+
+from ..base import AgentFileManager, BaseAgentSettings
+
+
+class FileWorkspaceMixin:
+ """Mixin that adds workspace support to a class"""
+
+ workspace: FileWorkspace = None
+ """Workspace that the agent has access to, e.g. for reading/writing files."""
+
+ def __init__(self, **kwargs):
+ # Initialize other bases first, because we need the config from BaseAgent
+ super(FileWorkspaceMixin, self).__init__(**kwargs)
+
+ file_manager: AgentFileManager = getattr(self, "file_manager")
+ if not file_manager:
+ return
+
+ self._setup_workspace()
+
+ def attach_fs(self, agent_dir: Path):
+ res = super(FileWorkspaceMixin, self).attach_fs(agent_dir)
+
+ self._setup_workspace()
+
+ return res
+
+ def _setup_workspace(self) -> None:
+ settings: BaseAgentSettings = getattr(self, "state")
+ assert settings.agent_id, "Cannot attach workspace to anonymous agent"
+ app_config: Config = getattr(self, "legacy_config")
+ file_manager: AgentFileManager = getattr(self, "file_manager")
+
+ ws_backend = app_config.workspace_backend
+ local = ws_backend == FileWorkspaceBackendName.LOCAL
+ workspace = get_workspace(
+ backend=ws_backend,
+ id=settings.agent_id if not local else "",
+ root_path=file_manager.root / "workspace" if local else None,
+ )
+ if local and settings.config.allow_fs_access:
+ workspace._restrict_to_root = False # type: ignore
+ workspace.initialize()
+ self.workspace = workspace
+
+
+def get_agent_workspace(agent: BaseAgent) -> FileWorkspace | None:
+ if isinstance(agent, FileWorkspaceMixin):
+ return agent.workspace
+
+ return None