Marty Oehme
765de505bb
The AnnotatedDocument class was, essentially, a simple tuple of a document and a list of annotations. While not bad in a vacuum, it is unwieldy and passing this around instead of a document, annotations, or both where necessary is more restrictive and frankly unnecessary. This commit removes the data class and any instances of its use. Instead, we now pass the individual components around to anything that needs them. This also frees us up to pass only annotations around for example. We also do not iterate through the selected papis documents to work on in each exporter anymore (since we only pass a single document), but in the main function itself. This leads to less duplication and makes the overall run function the overall single source of iteration through selected documents. Everything else only knows about a single document - the one it is operating on - which seems much neater. For now, it does not change much, but should make later work on extra exporters or extractors easier.
120 lines
3.3 KiB
Python
120 lines
3.3 KiB
Python
import click
|
|
import papis.cli
|
|
import papis.config
|
|
import papis.document
|
|
import papis.logging
|
|
import papis.notes
|
|
import papis.strings
|
|
from papis.document import Document
|
|
|
|
from papis_extract import exporter, extractor
|
|
from papis_extract.annotation import Annotation
|
|
from papis_extract.formatter import Formatter, formatters
|
|
|
|
logger = papis.logging.get_logger(__name__)
|
|
|
|
DEFAULT_OPTIONS = {
|
|
"plugins.extract": {
|
|
"tags": {},
|
|
"on_import": False,
|
|
"minimum_similarity": 0.75, # for checking against existing annotations
|
|
"minimum_similarity_content": 0.9, # for checking if highlight or note
|
|
"minimum_similarity_color": 0.833, # for matching tag to color
|
|
}
|
|
}
|
|
papis.config.register_default_settings(DEFAULT_OPTIONS)
|
|
|
|
|
|
@click.command("extract")
|
|
@click.help_option("-h", "--help")
|
|
@papis.cli.query_argument()
|
|
@papis.cli.doc_folder_option()
|
|
@papis.cli.git_option(help="Commit changes made to the notes files.")
|
|
@papis.cli.all_option()
|
|
@click.option(
|
|
"--write/--no-write",
|
|
"-w",
|
|
help="Do not write annotations to notes only print results to stdout.",
|
|
)
|
|
@click.option(
|
|
"--manual/--no-manual",
|
|
"-m",
|
|
help="Open note in editor for manual editing after annotation extraction.",
|
|
)
|
|
@click.option(
|
|
"--template",
|
|
"-t",
|
|
type=click.Choice(
|
|
list(formatters.keys()),
|
|
case_sensitive=False,
|
|
),
|
|
help="Choose an output template to format annotations with.",
|
|
)
|
|
@click.option(
|
|
"--force/--no-force",
|
|
"-f",
|
|
help="Do not drop any annotations because they already exist.",
|
|
)
|
|
def main(
|
|
query: str,
|
|
# _papis_id: bool,
|
|
# _file: bool,
|
|
# _dir: bool,
|
|
_all: bool,
|
|
doc_folder: str,
|
|
manual: bool,
|
|
write: bool,
|
|
template: str,
|
|
git: bool,
|
|
force: bool,
|
|
) -> None:
|
|
"""Extract annotations from any pdf document.
|
|
|
|
The extract plugin allows manual or automatic extraction of all annotations
|
|
contained in the pdf documents belonging to entries of the papis library.
|
|
It can write those changes to stdout or directly create and update notes
|
|
for papis documents.
|
|
|
|
It adds a `papis extract` subcommand through which it is invoked, but can
|
|
optionally run whenever a new document is imported for a papis entry,
|
|
if set in the plugin configuration.
|
|
"""
|
|
documents = papis.cli.handle_doc_folder_query_all_sort(
|
|
query, doc_folder, sort_field=None, sort_reverse=False, _all=_all
|
|
)
|
|
if not documents:
|
|
logger.warning(papis.strings.no_documents_retrieved_message)
|
|
return
|
|
|
|
formatter = formatters.get(template)
|
|
|
|
run(documents, edit=manual, write=write, git=git, formatter=formatter, force=force)
|
|
|
|
|
|
def run(
|
|
documents: list[Document],
|
|
formatter: Formatter | None,
|
|
edit: bool = False,
|
|
write: bool = False,
|
|
git: bool = False,
|
|
force: bool = False,
|
|
) -> None:
|
|
for doc in documents:
|
|
annotations: list[Annotation] = extractor.start(doc)
|
|
|
|
if write:
|
|
exporter.to_notes(
|
|
formatter=formatter or formatters["markdown-atx"],
|
|
document=doc,
|
|
annotations=annotations,
|
|
edit=edit,
|
|
git=git,
|
|
force=force,
|
|
)
|
|
else:
|
|
exporter.to_stdout(
|
|
formatter=formatter or formatters["markdown"],
|
|
document=doc,
|
|
annotations=annotations,
|
|
)
|