Base

Base abstractions of Parser and Converters. Parser parses a given document type into a ParsedDocumentType. Converter converts a given document from one format to another so that it can be compatible with an existing Parser. Example: We have a Parser that parses a .pdf document, we can have Converters that convert docx, pptx into pdf.

Converter

Bases: ABC

Source code in supermat/core/parser/base.py

class Converter(ABC):
    @abstractmethod
    def convert(self, file_path: Path) -> Path:  # noqa: U100
        """
        Converts input file to another file type and saves it. The saved file path is returned.

        Args:
            file_path (Path): Input file.

        Returns:
            Path: Output file after conversion.
        """

    def __call__(self, file_path: Path) -> Path:
        return self.convert(file_path)

convert(file_path) abstractmethod

Converts input file to another file type and saves it. The saved file path is returned.

Parameters:

Name	Type	Description	Default
file_path	Path	Input file.	required

Returns:

Name	Type	Description
Path	Path	Output file after conversion.

Source code in supermat/core/parser/base.py

@abstractmethod
def convert(self, file_path: Path) -> Path:  # noqa: U100
    """
    Converts input file to another file type and saves it. The saved file path is returned.

    Args:
        file_path (Path): Input file.

    Returns:
        Path: Output file after conversion.
    """

Parser

Bases: ABC

Source code in supermat/core/parser/base.py

class Parser(ABC):
    @abstractmethod
    def parse(self, file_path: Path) -> ParsedDocumentType:  # noqa: U100
        """
        Parse give file to ParsedDocumentType.

        Args:
            file_path (Path): Input file.

        Returns:
            ParsedDocumentType: Parsed document
        """

parse(file_path) abstractmethod

Parse give file to ParsedDocumentType.

Parameters:

Name	Type	Description	Default
file_path	Path	Input file.	required

Returns:

Name	Type	Description
ParsedDocumentType	ParsedDocumentType	Parsed document

Source code in supermat/core/parser/base.py

@abstractmethod
def parse(self, file_path: Path) -> ParsedDocumentType:  # noqa: U100
    """
    Parse give file to ParsedDocumentType.

    Args:
        file_path (Path): Input file.

    Returns:
        ParsedDocumentType: Parsed document
    """