from abc import ABC, abstractmethod
from typing import Optional
from dedoc.data_structures.unstructured_document import UnstructuredDocument
[docs]class BaseReader(ABC):
"""
This class is a base class for reading documents of any formats.
It allows to check if the specific reader can read the document of some format and
to get document's text with metadata, tables and attachments.
The metadata (or annotations) of the text are various and may include text boldness and color, footnotes or links to tables.
Some of the readers can also extract information about line type and hierarchy level (for example, list item) -
this information is stored in the `tag_hierarchy_level` attribute of the class :class:`~dedoc.data_structures.LineMetadata`.
"""
[docs] @abstractmethod
def read(self, path: str, document_type: Optional[str] = None, parameters: Optional[dict] = None) -> UnstructuredDocument:
"""
Read file from disk and extract text with annotations, tables and attachments from the document.
The given file should have appropriate extension and type so it should be checked by the method
:meth:`~dedoc.readers.BaseReader.can_read`, which should return True beforehand.
:param path: path to the file in the file system
:param document_type: type of the file, for example scientific article, presentation slides and so on
:param parameters: dict with additional parameters for document reader (as language for scans or delimiter for csv)
:return: intermediate representation of the document with lines, tables and attachments
"""
pass
[docs] @abstractmethod
def can_read(self, path: str, mime: str, extension: str, document_type: Optional[str] = None, parameters: Optional[dict] = None) -> bool:
"""
Check if this reader can handle the given file.
:param path: path to the file in the file system
:param mime: MIME type of a file
:param extension: file extension, for example .doc or .pdf
:param document_type: type of file, for example scientific article, presentation slides and so on
:param parameters: dict with additional parameters for document reader (as language for scans or delimiter for csv)
:return: True if this reader can handle the file, False otherwise
"""
pass
def _postprocess(self, document: UnstructuredDocument) -> UnstructuredDocument:
"""
Perform document postprocessing.
"""
return document