papis-extract/papis_extract/formatter.py

from collections.abc import Callable

from papis_extract.annotation import AnnotatedDocument

Formatter = Callable[[list[AnnotatedDocument]], str]


def format_markdown(
    docs: list[AnnotatedDocument] = [], atx_headings: bool = False
) -> str:
    template = (
        "{{#tag}}#{{tag}}\n{{/tag}}"
        "{{#quote}}> {{quote}}{{/quote}}{{#page}} [p. {{page}}]{{/page}}"
        "{{#note}}\n  NOTE: {{note}}{{/note}}"
    )
    output = ""
    for entry in docs:
        if not entry.annotations:
            continue

        heading = f"{entry.document['title']} - {entry.document['author']}\n"
        if atx_headings:
            output += f"# {heading}\n"
        else:
            title_decoration = (
                f"{'=' * len(entry.document.get('title', ''))}   "
                f"{'-' * len(entry.document.get('author', ''))}"
            )
            output += f"{title_decoration}\n" f"{heading}" f"{title_decoration}\n\n"

        for a in entry.annotations:
            output += a.format(template)
            output += "\n\n"

        output += "\n\n\n"

    return output.rstrip()


def format_markdown_atx(docs: list[AnnotatedDocument] = []) -> str:
    return format_markdown(docs, atx_headings=True)


def format_markdown_setext(docs: list[AnnotatedDocument] = []) -> str:
    return format_markdown(docs, atx_headings=False)


def format_count(docs: list[AnnotatedDocument] = []) -> str:
    output = ""
    for entry in docs:
        if not entry.annotations:
            continue

        count = 0
        for _ in entry.annotations:
            count += 1

        d = entry.document
        output += (
            f"{d['author'] if 'author' in d else ''}"
            f"{' - ' if 'author' in d else ''}"  # only put separator if author
            f"{entry.document['title'] if 'title' in d else ''}: "
            f"{count}\n"
        )

    return output.rstrip()


def format_csv(docs: list[AnnotatedDocument] = []) -> str:
    header: str = "type,tag,page,quote,note,author,title,ref,file"
    template: str = (
        '{{type}},{{tag}},{{page}},"{{quote}}","{{note}}",'
        '"{{doc.author}}","{{doc.title}}","{{doc.ref}}","{{file}}"'
    )
    output = f"{header}\n"
    for entry in docs:
        if not entry.annotations:
            continue

        d = entry.document
        for a in entry.annotations:
            output += a.format(template, doc=d)
            output += "\n"

    return output.rstrip()


formatters: dict[str, Formatter] = {
    "count": format_count,
    "csv": format_csv,
    "markdown": format_markdown,
    "markdown_atx": format_markdown_atx,
    "markdown_setext": format_markdown_setext,
}