How to include a Python module with the plugin

[SylvanKnight]

Back with another question for something I can't quite figure out.

I have the functionality I want (for the most part), but my plugin uses PyPDF2 to go through PDF text. When I tried to import the plugin to test it, I got the following error:

calibre, version 6.0.0
ERROR: Unhandled exception: <b>ModuleNotFoundError</b>:No module named 'PyPDF2'

calibre 6.0  embedded-python: True
Windows-10-10.0.19043 Windows ('64bit', 'WindowsPE')
('Windows', '10', '10.0.19043')
Python 3.10.1
Windows: ('10', '10.0.19043', '', 'Multiprocessor Free')
Interface language: None
Successfully initialized third party plugins: Edit Book plugin demo (1, 0, 0) && FanFicFare (4, 16, 0) && Goodreads (1, 7, 1) && Kindle hi-res covers (0, 5, 0)
Traceback (most recent call last):
  File "calibre\gui2\preferences\plugins.py", line 325, in add_plugin
  File "calibre\customize\ui.py", line 476, in add_plugin
  File "calibre\customize\ui.py", line 64, in load_plugin
  File "calibre\customize\zipplugin.py", line 304, in load
  File "importlib\__init__.py", line 126, in import_module
  File "<frozen importlib._bootstrap>", line 1050, in _gcd_import
  File "<frozen importlib._bootstrap>", line 1027, in _find_and_load
  File "<frozen importlib._bootstrap>", line 1006, in _find_and_load_unlocked
  File "<frozen importlib._bootstrap>", line 688, in _load_unlocked
  File "calibre\customize\zipplugin.py", line 203, in exec_module
  File "calibre_plugins.dummy2.__init__", line 9, in <module>
ModuleNotFoundError: No module named 'PyPDF2'

I'm assuming that's because PyPDF2 isn't in Calibre. My question is now

1) What PDF tools are in Calibre so that I can use those instead of PyPDF2, or
2) How do I include PyPDF2 with my plugin?

Thanks in advance

[kovidgoyal]

Simply include it in the plugin zip file. Although there are builtin tools in calibre to do the things pypdf2 does, but faster and more robustly. As for what they are it depends onw hat you want to do, its not a single package.

[SylvanKnight]

There is a fanfiction hosting site called Archive of Our Own. One of the features of the site is that you can download PDF, MOBI, and EPUB (as well as other) versions of individual works. My wife has over the years downloaded several hundred works this way. When you download a MOBI or EPUB version, it has appropriate metadata embedded in (tags, published date, place in a series, etc.). However, she has downloaded PDF versions, which contains none of this. All of the same information is usually on the first two pages of the PDF. I'm just trying to grab all the information in those first few pages, sort it out appropriately, and put it into the appropriate categories as its imported into Calibre if it's an AO3 PDF.

[kovidgoyal]

If you want to extract text from the pdf calibre includes the pdftohtml and pdfttotext binaries form the poppler project, use those. See pdftohtml.py in the calibre source for examples of how to use.

[SylvanKnight]

Once I've included the module in the plugin, how do I call it inside the plugin? Is it

`from <plugin name> import <module>`?

[kovidgoyal]

Assuming its a single file module you will import it just like any other module in your plugin

[SylvanKnight]

I'm trying to include PyPDF2 in my plugin. Maybe I'm doing something terribly wrong.

I call it like

from PyPDF2 import PdfReader

When I upload the plugin into Calibre to test it, I get an error

ModuleNotFoundError:No module named 'PyPDF2'

I've attached both the zip and the __init__ if anyone is willing to look at/help.

[capink]

Looking at the zip file, your plugin does not have an import name. You create an import name by creating an empty text file in the root of your plugin with the following name:

plugin-import-name-ao3_tagger.txt

You can change the part highlighted in blue, so long as you stick to only including letters, numbers and underscores.

Originally Posted by SylvanKnight

I call it like

from PyPDF2 import PdfReader

After adding the import name as explained above, you should modify the import statement to include your import name as follows:

from calibre_plguins.ao3_tagger.PyPDF2 import PdfReader

Note: I have not tested whether the above instructions work with your plugin. Will leave that to you.

[SylvanKnight]

Same error still

calibre, version 6.9.0
ERROR: Unhandled exception: <b>ModuleNotFoundError</b>:No module named 'PyPDF2'

calibre 6.9 embedded-python: True
Windows-10-10.0.19045-SP0 Windows ('64bit', 'WindowsPE')
('Windows', '10', '10.0.19045')
Python 3.10.1
Windows: ('10', '10.0.19045', 'SP0', 'Multiprocessor Free')
Interface language: None
Successfully initialized third party plugins: Edit Book plugin demo (1, 0, 0) && FanFicFare (4, 18, 0) && Goodreads (1, 7, 1) && Kindle hi-res covers (0, 5, 0)
Traceback (most recent call last):
File "calibre\gui2\preferences\plugins.py", line 325, in add_plugin
File "calibre\customize\ui.py", line 479, in add_plugin
File "calibre\customize\ui.py", line 64, in load_plugin
File "calibre\customize\zipplugin.py", line 307, in load
File "importlib\__init__.py", line 126, in import_module
File "<frozen importlib._bootstrap>", line 1050, in _gcd_import
File "<frozen importlib._bootstrap>", line 1027, in _find_and_load
File "<frozen importlib._bootstrap>", line 1006, in _find_and_load_unlocked
File "<frozen importlib._bootstrap>", line 688, in _load_unlocked
File "calibre\customize\zipplugin.py", line 206, in exec_module
File "calibre_plugins.ao3_tagger.__init__", line 13, in <module>
File "calibre_plugins.ao3_tagger.__init__", line 25, in AO3PdfTagger
File "calibre\customize\zipplugin.py", line 206, in exec_module
File "calibre_plugins.ao3_tagger.PyPDF2.__init__", line 10, in <module>
File "calibre\customize\zipplugin.py", line 206, in exec_module
File "calibre_plugins.ao3_tagger.PyPDF2._encryption ", line 34, in <module>
ModuleNotFoundError: No module named 'PyPDF2'


I've tried having the import inside and outside of the class.

[SylvanKnight]

I realize that having files to download to see what they're doing isn't fair to ask of people, so I put it into a GitHub repo

https://github.com/Sylvan-Knight/ao3_tagger

[Doitsu]

Apparently, the error messages are caused by some modules in the PyPDF2 folder who reference the PyPDF2 folder, e.g. _encryption.py.
If you remove "PyPDF2." from these modules, you won't get any error messages, but the plugin doesn't seem to work.

[SylvanKnight]

That's what it was. I did a find/replace and now it's at least running in Calibre. Now to debug so it does what I want it to do...