Start "edit book" plugin in Calibre 5

[wolf123]

Hi everyone!

I would like to make sure my "edit book" plugin works correctly on Calibre 5, but I am having trouble starting the plugin.

Calibre loads normally, I can modify the plugin preferences in Calibre Preferences, but when I start the book editor I can't see the plugin tab in the toolbar nor I can start the plugin via keyboard shortcut.

The plugin works correctly in Calibre 3 and 4. Here is the debug log (I fire up Calibre and open the book editor):

calibre 5.10.1 [64bit]  embedded-python: True is64bit: True
Windows-10-10.0.18362 Windows ('64bit', 'WindowsPE')
('Windows', '10', '10.0.18362')
Python 3.8.5
Windows: ('10', '10.0.18362', '', 'Multiprocessor Free')
Interface language: en_GB
Successfully initialized third party plugins: Access Aide (0, 1, 2) && KindleUnpack - The Plugin (0, 82, 1)
Turning on automatic hidpi scaling
devicePixelRatio: 1.0
logicalDpi: 96.0 x 96.0
physicalDpi: 102.23899371069182 x 102.35820895522387
Using calibre Qt style: True
[0.00] Starting up...
[0.00] Showing splash screen...
[1.41] splash screen shown
[1.41] Initializing db...
[1.42] db initialized
[1.42] Constructing main UI...
[2.30] main UI initialized...
[2.30] Hiding splash screen
Starting QuickView
[2.45] splash screen hidden
[2.45] Started up in 2.45 seconds with 1 books
Worker Launch took: 0.00 seconds

Any thought about this? Am I missing something?
Thanks!

[kovidgoyal]

run

calibre-debug -t


to ge tthe debug output for the editor.

[wolf123]

Thank you so much!!

There were two python3 compatibility issues. The plugin now works correctly.

If this could be useful to others, I debugged the file using 2to3

$ 2to3-2.7 main.py 
RefactoringTool: Skipping optional fixer: buffer
RefactoringTool: Skipping optional fixer: idioms
RefactoringTool: Skipping optional fixer: set_literal
RefactoringTool: Skipping optional fixer: ws_comma
RefactoringTool: Refactored main.py
--- main.py	(original)
+++ main.py	(refactored)
@@ -12,7 +12,7 @@
 from calibre_plugins.access_aide.config import prefs
 
 # My modules
-from lib.stats import Stats
+from .lib.stats import Stats
 
 
 class AccessAide(Tool):
@@ -61,7 +61,7 @@
         blacklist = ['toc.xhtml']
 
         # iterate over book files
-        for name, media_type in container.mime_map.items():
+        for name, media_type in list(container.mime_map.items()):
 
             if media_type in OEB_DOCS \
                and name not in blacklist:
RefactoringTool: Files that need to be modified:
RefactoringTool: main.py

[thiago.eec]

I was going to say that it worked here, but seems like I got the fixed version.

By the way:

1) The plugin seems not to handle multiple epub:type's. Ex.: epub:type="bodymatter chapter". In this case, it does not add the 'doc-chapter' role.

2) When you execute the plugin, the editor doesn't seem to notice the changes (the save buttons stays greyed out). Also, when closing, it does not ask to save, and you loose the changes.

Originally Posted by wolf123

Thank you so much!!

There were two python3 compatibility issues. The plugin now works correctly.

If this could be useful to others, I debugged the file using 2to3

$ 2to3-2.7 main.py 
RefactoringTool: Skipping optional fixer: buffer
RefactoringTool: Skipping optional fixer: idioms
RefactoringTool: Skipping optional fixer: set_literal
RefactoringTool: Skipping optional fixer: ws_comma
RefactoringTool: Refactored main.py
--- main.py	(original)
+++ main.py	(refactored)
@@ -12,7 +12,7 @@
 from calibre_plugins.access_aide.config import prefs
 
 # My modules
-from lib.stats import Stats
+from .lib.stats import Stats
 
 
 class AccessAide(Tool):
@@ -61,7 +61,7 @@
         blacklist = ['toc.xhtml']
 
         # iterate over book files
-        for name, media_type in container.mime_map.items():
+        for name, media_type in list(container.mime_map.items()):
 
             if media_type in OEB_DOCS \
                and name not in blacklist:
RefactoringTool: Files that need to be modified:
RefactoringTool: main.py

[wolf123]

Originally Posted by thiago.eec

I was going to say that it worked here, but seems like I got the fixed version.

By the way:

1) The plugin seems not to handle multiple epub:type's. Ex.: epub:type="bodymatter chapter". In this case, it does not add the 'doc-chapter' role.

2) When you execute the plugin, the editor doesn't seem to notice the changes (the save buttons stays greyed out). Also, when closing, it does not ask to save, and you loose the changes.

Thank you so much, Thiago!! This is a very useful feedback.

I will definitely look into point 2. I'll check if the documentation mentions something about this.

Regarding point 1, I feel you have more experience than I do here. Is it OK to overload (add multiple values in) epub:type? Do I risk to subsequently overload aria roles?

Many thanks!!

[thiago.eec]

Originally Posted by wolf123

Is it OK to overload (add multiple values in) epub:type?

No, you can use multiple values for epub:type:

The epub:type attribute inflects semantics on the element on which it appears. Its value is one or more white space-separated terms stemming from external vocabularies associated with the document instance, as defined in Vocabulary Association.

Source


For instance, you can use multiple values to define Document Partition and Section, like these examples:

<section epub:type="frontmatter preface" role="doc-preface">...</section>
<section epub:type="backmatter colophon" role="doc-colophon">...</section>

The order is not important either for epub:type values.

Originally Posted by wolf123

Do I risk to subsequently overload aria roles?

Like the link you pointed clearly says: you must not overload the aria roles. Only use one value. A second value can only be used as fallback, since only the first value is recognized.
So, you would have to detect multiple values for epub:type and use only the appropriate one while mapping to aria roles. Usually, only one of the epub:type values has a corresponding aria role.

[wolf123]

Originally Posted by thiago.eec

No, you can use multiple values for epub:type:


Source


For instance, you can use multiple values to define Document Partition and Section, like these examples:

<section epub:type="frontmatter preface" role="doc-preface">...</section>
<section epub:type="backmatter colophon" role="doc-colophon">...</section>

The order is not important either for epub:type values.



Like the link you pointed clearly says: you must not overload the aria roles. Only use one value. A second value can only be used as fallback, since only the first value is recognized.
So, you would have to detect multiple values for epub:type and use only the appropriate one while mapping to aria roles. Usually, only one of the epub:type values has a corresponding aria role.

Thank you so much, this is super useful!

I've just [added a feature](https://github.com/OpenBookPublisher...d6105f8c6a5a82) to allow this behaviour. It will be included in the next plugin release. Thanks so much!!