Skip to content

2 small changes to import annotations from external services #30

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bramvandenbussche wants to merge 4 commits into
base: master
Choose a base branch
from
Open

2 small changes to import annotations from external services #30

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7ccf4d0
Allow ExportingReader classes to skip the Text Input dialogue
bramvandenbussche Jul 31, 2022
8b30486
If selected ExportingReader doesn't need a book selected, don't stop it
bramvandenbussche Jul 31, 2022
16ec0a9
Improve documentation of SampleExportingApp
bramvandenbussche Jul 31, 2022
aada154
Provide sensible default value
bramvandenbussche Jul 31, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 21 additions & 6 deletions action.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -803,14 +803,22 @@ def import_annotations(self, reader_app):
supported_reader_apps = ReaderApp.get_reader_app_classes()
reader_app_class = supported_reader_apps[reader_app]

try:
requires_book_selected = reader_app_class.REQUIRES_BOOK_SELECTED
except AttributeError:
requires_book_selected = True

# Save a reference for merge_annotations
self.reader_app_class = reader_app_class

self.selected_mi = get_selected_book_mi(self.get_options(),
msg=self.SELECT_DESTINATION_MSG,
det_msg=self.SELECT_DESTINATION_DET_MSG)
if not self.selected_mi:
return
if requires_book_selected:
self.selected_mi = get_selected_book_mi(self.get_options(),
msg=self.SELECT_DESTINATION_MSG,
det_msg=self.SELECT_DESTINATION_DET_MSG)
if not self.selected_mi:
return
else:
self.selected_mi = None

ra_confidence = reader_app_class.import_fingerprint

Expand All @@ -822,7 +830,14 @@ def import_annotations(self, reader_app):
if reader_app_class.SUPPORTS_FILE_CHOOSER:
raw_data = ImportAnnotationsFileDialog(self, reader_app_class).text()
else:
raw_data = ImportAnnotationsTextDialog(self, reader_app, reader_app_class).text()
try:
if reader_app_class.REQUIRES_TEST_INPUT == True:
raw_data = ImportAnnotationsTextDialog(self, reader_app, reader_app_class).text()
else:
raw_data = "-"
except AttributeError:
raw_data = ImportAnnotationsTextDialog(self, reader_app, reader_app_class).text()

if(raw_data):
# Instantiate reader_app_class
rac = reader_app_class(self)
Expand Down
10 changes: 10 additions & 0 deletions readers/SampleExportingApp.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,16 @@ class SampleExportingApp(ExportingReader):
# Change this to True when developing a new class from this template
SUPPORTS_EXPORTING = True

# If this is set to true, a text dialog will be shown prior to calling parse_exported_highlights
# and the contents of the dialog will be passed in via the raw parameter
# If set to false, no dialog will be displayed and parse_exported_highlights will be called with raw == "-"
REQUIRES_TEST_INPUT = True

# If this is set to true, it means the class needs the user to select a book prior to invoking this action.
# If a book isn't selected, the user will receive a warning and nothing will happen
# If this is set to false, the user can call the class with 0 or more books selected, it's up to you to handle all scenarios
REQUIRES_BOOK_SELECTED = True

# Change this to True to use a file chooser instead of text input box for import
SUPPORTS_FILE_CHOOSER = False
import_file_name_filter = "All files (*)"
Expand Down