aboutsummaryrefslogtreecommitdiff
path: root/autogpts/autogpt/autogpt/agents/features/file_workspace.py
blob: 22ab8119d592773b5a6e92cf26c42ad9ee779976 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
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