File storage

Module for abstract representation of a storage system holding files.

FileStorage

Bases: ABC

Abstract file storage class.

Source code in mkdocs/lakehouse_engine/packages/utils/storage/file_storage.py

class FileStorage(ABC):
    """Abstract file storage class."""

    @classmethod
    @abstractmethod
    def get_file_payload(cls, url: ParseResult) -> Any:
        """Get the payload of a file.

        Args:
            url: url of the file.

        Returns:
            File payload/content.
        """
        pass

    @classmethod
    @abstractmethod
    def write_payload_to_file(cls, url: ParseResult, content: str) -> None:
        """Write payload into a file.

        Args:
            url: url of the file.
            content: content to write into the file.
        """
        pass

get_file_payload(url) abstractmethod classmethod

Get the payload of a file.

Parameters:

Name	Type	Description	Default
url	ParseResult	url of the file.	required

Returns:

Type	Description
Any	File payload/content.

Source code in mkdocs/lakehouse_engine/packages/utils/storage/file_storage.py

@classmethod
@abstractmethod
def get_file_payload(cls, url: ParseResult) -> Any:
    """Get the payload of a file.

    Args:
        url: url of the file.

    Returns:
        File payload/content.
    """
    pass

write_payload_to_file(url, content) abstractmethod classmethod

Write payload into a file.

Parameters:

Name	Type	Description	Default
url	ParseResult	url of the file.	required
content	str	content to write into the file.	required

Source code in mkdocs/lakehouse_engine/packages/utils/storage/file_storage.py

@classmethod
@abstractmethod
def write_payload_to_file(cls, url: ParseResult, content: str) -> None:
    """Write payload into a file.

    Args:
        url: url of the file.
        content: content to write into the file.
    """
    pass