Files
dify/api/extensions/storage/base_storage.py
2026-03-17 19:47:16 +08:00

41 lines
1.2 KiB
Python

"""Abstract interface for file storage implementations."""
from abc import ABC, abstractmethod
from collections.abc import Generator
class BaseStorage(ABC):
"""Interface for file storage."""
@abstractmethod
def save(self, filename: str, data: bytes) -> None:
raise NotImplementedError
@abstractmethod
def load_once(self, filename: str) -> bytes:
raise NotImplementedError
@abstractmethod
def load_stream(self, filename: str) -> Generator[bytes, None, None]:
raise NotImplementedError
@abstractmethod
def download(self, filename: str, target_filepath: str) -> None:
raise NotImplementedError
@abstractmethod
def exists(self, filename: str) -> bool:
raise NotImplementedError
@abstractmethod
def delete(self, filename: str) -> None:
raise NotImplementedError
def scan(self, path: str, files: bool = True, directories: bool = False) -> list[str]:
"""
Scan files and directories in the given path.
This method is implemented only in some storage backends.
If a storage backend doesn't support scanning, it will raise NotImplementedError.
"""
raise NotImplementedError("This storage backend doesn't support scanning")