from collections.abc import Callable from papis.document import Document from papis_extract.annotation import Annotation Formatter = Callable[[Document, list[Annotation]], str] def format_markdown( document: Document = Document(), annotations: list[Annotation] = [], headings: str = "setext", # setext | atx | None ) -> str: if not annotations: return "" template = ( "{{#tag}}#{{tag}}\n{{/tag}}" "{{#quote}}> {{quote}}{{/quote}}{{#page}} [p. {{page}}]{{/page}}" "{{#note}}\n NOTE: {{note}}{{/note}}" ) output = "" heading = f"{document.get('title', '')} - {document.get('author', '')}" if headings == "atx": output = f"# {heading}\n\n" elif headings == "setext": title_decoration = ( f"{'=' * len(document.get('title', ''))} " f"{'-' * len(document.get('author', ''))}" ) output = f"{title_decoration}\n{heading}\n{title_decoration}\n\n" else: output = "" for a in annotations: output += a.format(template) output += "\n\n" output += "\n\n\n" return output.rstrip() def format_markdown_atx( document: Document = Document(), annotations: list[Annotation] = [], ) -> str: return format_markdown(document, annotations, headings="atx") def format_markdown_setext( document: Document = Document(), annotations: list[Annotation] = [], ) -> str: return format_markdown(document, annotations, headings="setext") def format_count( document: Document = Document(), annotations: list[Annotation] = [], ) -> str: if not annotations: return "" count = 0 for _ in annotations: count += 1 return ( f"{document.get('author', '')}" f"{' - ' if 'author' in document else ''}" # only put separator if author f"{document.get('title', '')}: " f"{count}\n" ).rstrip() def format_csv( document: Document = Document(), annotations: list[Annotation] = [], ) -> 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" if not annotations: return "" for a in annotations: output += a.format(template, doc=document) 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, }