papis-extract/papis_extract/extraction.py

53 lines
1.3 KiB
Python
Raw Normal View History

import re
2023-08-28 08:28:06 +00:00
from pathlib import Path
from typing import Protocol
2023-08-28 08:28:06 +00:00
import fitz
2023-08-28 08:28:06 +00:00
import papis.config
import papis.document
import papis.logging
from papis.document import Document
2023-08-28 08:28:06 +00:00
from papis_extract.annotation import Annotation
2023-08-28 08:28:06 +00:00
2023-08-28 10:53:03 +00:00
logger = papis.logging.get_logger(__name__)
class Extractor(Protocol):
def can_process(self, filename: Path) -> bool:
...
def run(self, filename: Path) -> list[Annotation]:
...
def start(
extractor: Extractor,
document: Document,
) -> list[Annotation]:
"""Extract all annotations from passed documents.
2023-08-28 08:28:06 +00:00
Returns all annotations contained in the papis
documents passed in.
"""
annotations: list[Annotation] = []
file_available: bool = False
for file in document.get_files():
fname = Path(file)
if not extractor.can_process(fname):
continue
file_available = True
try:
annotations.extend(extractor.run(fname))
except fitz.FileDataError as e:
print(f"File structure errors for {file}.\n{e}")
if not file_available:
# have to remove curlys or papis logger gets upset
desc = re.sub("[{}]", "", papis.document.describe(document))
logger.warning("Did not find suitable file for document: " f"{desc}")
return annotations