[Editor Plugin] EpubCheck

[thiago.eec]

Originally Posted by kovidgoyal

the editor does work independently of the main program. @Doitsu when you call subprocess to run epubcheck, you should specify the creationflags variable to ensure cd window is not created. something like

import win32process
subprocess.Popen(...., creationflags=win32process.CREATE_NO_WINDOW)

Thanks for the help, Kovid!

Originally Posted by Doitsu

Thanks for the code snippet! I'll add it to the plugin and release a new version today.

Thanks Doitsu for the quick correction. It works perfectly now!

[kobayashi]

The 0.1.4 update causes Calibre to hang and never update on my Mac.

[odamizu]

Originally Posted by kobayashi

The 0.1.4 update causes Calibre to hang and never update on my Mac.

Can you provide more details? Just tested this on my Mac, and it's working for me.

[Doitsu]

Originally Posted by kobayashi

The 0.1.4 update causes Calibre to hang and never update on my Mac.

Most likely the file download was incomplete. Please re-download the plugin zip file and generate an MD5 checksum for it:

1. Open a terminal window.
2. Enter md5
3. Drag & drop EpubCheck.zip from the Downloads folder to the Terminal window and hit Enter.

The MD5 value should be 040b7ec0fb115afee69441384cb20017.

[kobayashi]

Originally Posted by Doitsu

Most likely the file download was incomplete. Please re-download the plugin zip file and generate an MD5 checksum for it:

1. Open a terminal window.
2. Enter md5
3. Drag & drop EpubCheck.zip from the Downloads folder to the Terminal window and hit Enter.

The MD5 value should be 040b7ec0fb115afee69441384cb20017.

That may have been the issue. Tried it again this morning and it worked as normal.

[JSWolf]

I've just run the new version for the first time with the Calibre editor. I have gotten 18 warnings. Would it be possible to fix the plugin so we can see the warnings and fix them if we want? Thanks.

[Doitsu]

Originally Posted by JSWolf

I have gotten 18 warnings. Would it be possible to fix the plugin so we can see the warnings and fix them if we want?

I don't understand your problem. The new version might display more warnings, but other than that it should behave exactly as the old version.
If it doesn't, please provide more details.

[thiago.eec]

Thank you for the update, @Doitsu. That was fast!

[DNSB]

Originally Posted by Doitsu

I don't understand your problem. The new version might display more warnings, but other than that it should behave exactly as the old version.
If it doesn't, please provide more details.

When I played with it, I detached the postage stamp sized window used for epubcheck's output and dumped it on a second monitor where I resized it to a more useful size. I used a couple of test files and had 5 more errors using the new version than the old version generated.

[Doitsu]

Hi David,

Originally Posted by DNSB

I detached the postage stamp sized window used for epubcheck's output and dumped it on a second monitor

You can have the plugin automatically close the Check book panel. (You can also have the plugin copy the raw EPUBCheck messages to the system clipboard, by adding a "clipboard_copy": true entry to EpubCheck.json.)

Originally Posted by DNSB

I used a couple of test files and had 5 more errors using the new version than the old version generated.

Thanks for your report. Can you please post the five error messages and the code fragments that they refer to?

BTW, the only additional message that I got for files created by very old Calibre/Sigil versions was:

ERROR(NCX-001): temp.epub/OEBPS/toc.ncx(-1,-1): NCX identifier ('xxx') does 
not match OPF identifier ('urn:uuid:xxx').

And this message is by design:

Features
...
report non-matching identifiers in OPF and NCX as an error again (515682dc)
...

D.

[DNSB]

Originally Posted by Doitsu

Thanks for your report. Can you please post the five error messages and the code fragments that they refer to?

I fixed the errors so don't have the original document anymore. I think one of the errors was related to an empty [tours][/tours] entry in content.opf.

[thiago.eec]

Hi, @Doitsu

Altough I'm a complete noob to python (an to programming in general), I was trying to modify your plugin so I could pass the "--usage" argument to epubcheck. I've tried changing this lines:

Spoiler:

line 131:   args = ['java', '-jar', epc_path, '--version', epub_path]

to

line 131:   args = ['java', '-jar', epc_path, '--version', epub_path, '--usage']

Spoiler:

line 163:   if line.startswith(('ERROR', 'WARNING', 'FATAL', 'INFO')):

to

line 163:   if line.startswith(('ERROR', 'WARNING', 'FATAL', 'INFO', 'USAGE')):

Spoiler:

line 295:   elif err_code.startswith('WARNING'):

to

line 295:   elif err_code.startswith(('WARNING', 'USAGE')):

But I got no luck... Is this possible? Am I just missing some other reference or it would need a more profound change to the code?

EDIT: Of course this wouldn't be default behavior. It could be enabled by another entry to EpubCheck.json. Somethin like "usage": true.

[Doitsu]

Originally Posted by thiago.eec

Am I just missing some other reference or it would need a more profound change to the code?

For someone who claims to be a noob, you've made all the right changes.
However, you (and I) underestimated the EPUBCheck developers. Since they don't consider USAGE messages errors, all USAGE messages are written to stdout not stderr.

Since the plugin only checked stderr for error messages, they were ignored.

Your changes should work if you also add the following line:

                stderr = result[1].decode(os_encoding)
                stderr += stdout

Make sure not to use tabs for the indentation; it'd best if you copied the line before it and edited it.

(I've also attached an updated version of main.py for your convenience.)

Originally Posted by thiago.eec

EDIT: Of course this wouldn't be default behavior. It could be enabled by another entry to EpubCheck.json. Somethin like "usage": true.

I might add an "usage": true option in the next version.

[thiago.eec]

Originally Posted by Doitsu

For someone who claims to be a noob, you've made all the right changes.

I'm just good at guessing... I can read most of the codes in plugins and make small tweaks. If it gets a little deeper, than I'm in trouble.

Originally Posted by Doitsu

(I've also attached an updated version of main.py for your convenience.)

Thank you very much for the quick reply and the altered script.


EDIT: Got it reading from EpubCheck.json now.

[Doitsu]

Originally Posted by thiago.eec

Got it reading from EpubCheck.json now.

Good job!