Skip to content

base_file_manager_driver

BaseFileManagerDriver

Bases: ABC

BaseFileManagerDriver can be used to list, load, and save files.

Attributes:

Name Type Description
default_loader

The default loader to use for loading file contents into artifacts.
loaders

Dictionary of file extension specific loaders to use for loading file contents into artifacts.
Source code in griptape/drivers/file_manager/base_file_manager_driver.py 
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
66
67
68
69
70
71
72
@define
class BaseFileManagerDriver(ABC):
    """BaseFileManagerDriver can be used to list, load, and save files.

    Attributes:
        default_loader: The default loader to use for loading file contents into artifacts.
        loaders: Dictionary of file extension specific loaders to use for loading file contents into artifacts.
    """

    _workdir: str = field(kw_only=True, alias="workdir")
    encoding: Optional[str] = field(default=None, kw_only=True)

    @property
    @abstractmethod
    def workdir(self) -> str: ...

    @workdir.setter
    @abstractmethod
    def workdir(self, value: str) -> None: ...

    def list_files(self, path: str) -> TextArtifact:
        entries = self.try_list_files(path)
        return TextArtifact("\n".join(list(entries)))

    @abstractmethod
    def try_list_files(self, path: str) -> list[str]: ...

    def load_file(self, path: str) -> BlobArtifact | TextArtifact:
        if self.encoding is None:
            return BlobArtifact(self.try_load_file(path))
        else:
            return TextArtifact(self.try_load_file(path).decode(encoding=self.encoding), encoding=self.encoding)

    @abstractmethod
    def try_load_file(self, path: str) -> bytes: ...

    def save_file(self, path: str, value: bytes | str) -> InfoArtifact:
        if isinstance(value, str):
            value = value.encode() if self.encoding is None else value.encode(encoding=self.encoding)
        elif isinstance(value, (bytearray, memoryview)):
            raise ValueError(f"Unsupported type: {type(value)}")

        location = self.try_save_file(path, value)

        return InfoArtifact(f"Successfully saved file at: {location}")

    @abstractmethod
    def try_save_file(self, path: str, value: bytes) -> str: ...

    def load_artifact(self, path: str) -> BaseArtifact:
        response = self.try_load_file(path)
        return BaseArtifact.from_json(
            response.decode() if self.encoding is None else response.decode(encoding=self.encoding)
        )

    def save_artifact(self, path: str, artifact: BaseArtifact) -> InfoArtifact:
        artifact_json = artifact.to_json()
        value = artifact_json.encode() if self.encoding is None else artifact_json.encode(encoding=self.encoding)

        location = self.try_save_file(path, value)

        return InfoArtifact(f"Successfully saved artifact at: {location}")

encoding: Optional[str] = field(default=None, kw_only=True) class-attribute instance-attribute

workdir: str abstractmethod property writable

list_files(path)

Source code in griptape/drivers/file_manager/base_file_manager_driver.py 
31
32
33
def list_files(self, path: str) -> TextArtifact:
    entries = self.try_list_files(path)
    return TextArtifact("\n".join(list(entries)))

load_artifact(path)

Source code in griptape/drivers/file_manager/base_file_manager_driver.py 
60
61
62
63
64
def load_artifact(self, path: str) -> BaseArtifact:
    response = self.try_load_file(path)
    return BaseArtifact.from_json(
        response.decode() if self.encoding is None else response.decode(encoding=self.encoding)
    )

load_file(path)

Source code in griptape/drivers/file_manager/base_file_manager_driver.py 
38
39
40
41
42
def load_file(self, path: str) -> BlobArtifact | TextArtifact:
    if self.encoding is None:
        return BlobArtifact(self.try_load_file(path))
    else:
        return TextArtifact(self.try_load_file(path).decode(encoding=self.encoding), encoding=self.encoding)

save_artifact(path, artifact)

Source code in griptape/drivers/file_manager/base_file_manager_driver.py 
66
67
68
69
70
71
72
def save_artifact(self, path: str, artifact: BaseArtifact) -> InfoArtifact:
    artifact_json = artifact.to_json()
    value = artifact_json.encode() if self.encoding is None else artifact_json.encode(encoding=self.encoding)

    location = self.try_save_file(path, value)

    return InfoArtifact(f"Successfully saved artifact at: {location}")

save_file(path, value)

Source code in griptape/drivers/file_manager/base_file_manager_driver.py 
47
48
49
50
51
52
53
54
55
def save_file(self, path: str, value: bytes | str) -> InfoArtifact:
    if isinstance(value, str):
        value = value.encode() if self.encoding is None else value.encode(encoding=self.encoding)
    elif isinstance(value, (bytearray, memoryview)):
        raise ValueError(f"Unsupported type: {type(value)}")

    location = self.try_save_file(path, value)

    return InfoArtifact(f"Successfully saved file at: {location}")

try_list_files(path) abstractmethod

Source code in griptape/drivers/file_manager/base_file_manager_driver.py 
35
36
@abstractmethod
def try_list_files(self, path: str) -> list[str]: ...

try_load_file(path) abstractmethod

Source code in griptape/drivers/file_manager/base_file_manager_driver.py 
44
45
@abstractmethod
def try_load_file(self, path: str) -> bytes: ...

try_save_file(path, value) abstractmethod

Source code in griptape/drivers/file_manager/base_file_manager_driver.py 
57
58
@abstractmethod
def try_save_file(self, path: str, value: bytes) -> str: ...