UnicodeWarning when running Sigil plugin

[turbulent]

When running a Sigil plugin, if the current path contains non-ASCII character, the plugin runner dialog will display the message:

C:\Program Files\Sigil\plugin_launchers\\python\launcher.py:2 43: UnicodeWarning: Unicode equal comparison failed to convert both arguments to Unicode - interpreting them as being unequal
if script_home not in sys.path:

The message is displayed only when the plugin is running. When the plugin finishes running, the message will be replaced by the output of plugin.

[KevinH]

Hi turbulent,
I think this is an artifact of python 2.7, that keeps its internal search paths as bytestrings, not full unicode. The launcher itself is full unicode. Being marked as unequal is the safest path forward and should not hurt anything. If the plugin actually started then this warning can be safely ignored. I will include a work around for this for python 2.7 in the next release to prevent the warning.

Thank you for your bug report!

KevinH

Originally Posted by turbulent

When running a Sigil plugin, if the current path contains non-ASCII character, the plugin runner dialog will display the message:

C:\Program Files\Sigil\plugin_launchers\\python\launcher.py:2 43: UnicodeWarning: Unicode equal comparison failed to convert both arguments to Unicode - interpreting them as being unequal
if script_home not in sys.path:

The message is displayed only when the plugin is running. When the plugin finishes running, the message will be replaced by the output of plugin.

[turbulent]

Hi KevinH,

Yes, I'm using Python 2.7 with Sigil 0.8.2. I'm glad that this warning is not a big deal and can be ignored.

I've another question about errors. I'm learning to write my own plugin now. I used to add some print statement in the script for debug purpose. But I find that for Sigil plugin, the stdout is displayed only when the plugin returned successfully. When something goes wrong and throws a exception, only the error message is displayed, and I lose the helpful hints from the "prints". I wonder whether there is kind of "best practise" in the situation?

[KevinH]

Hi,
That was fixed in Sigil 0.8.2. Are you sure you are using the very latest version?
Cuurently a print statement will show up immediately in the PluginRunner Window.

Kevin

[KevinH]

Hi,
And the full traceback of the exception should get caught and printed in the launcher unless you catch the exception yourself.

Kevin

[KevinH]

Hi,

I have now removed the warning. This fix should appear in the next release of Sigil.

KevinH

[turbulent]

Originally Posted by KevinH

Hi,
That was fixed in Sigil 0.8.2. Are you sure you are using the very latest version?
Cuurently a print statement will show up immediately in the PluginRunner Window.

Kevin

Hi, Kevin

I'm using Sigil 0.8.2 on Win7. I create a test plugin as below:

def run(bk):
    print 'This line should be displayed.'
    print variable_not_exist
    return 0

Running this plugin, the message is:

Status: failed

Traceback (most recent call last):
  File "C:\Program Files\Sigil\plugin_launchers\\python\launcher.py", line 135, in launch
    self.exitcode = target_script.run(container)
  File "C:\Users\xj\AppData\Local\sigil-ebook\sigil\plugins\test\plugin.py", line 7, in run
    print variable_not_exist
NameError: global name 'variable_not_exist' is not defined
Error: global name 'variable_not_exist' is not defined

"variable_not_exist" is undefined to trigger the error. I expect the message "This line should be displayed." to show up. But it didn't.

[turbulent]

Originally Posted by KevinH

Hi,

I have now removed the warning. This fix should appear in the next release of Sigil.

KevinH

So nice of you! Thanks for your effort in providing us more and more wonderful Sigil for editing epub files.

[KevinH]

Hi,
It actually did but was quickly replaced with the error message when the plugin-ended.

So if you were to run a longer plugin you would see that print output. That way the plugin can update the user using simple print statements while running longer tasks.

If you use your own try/catch block and handle the error, you would see the print output. But as soon as the plugin completes it will show either stdout on success or stderror on failure and not some asynchronous mix.

Hope this explains how things are meant to work.

KevinH

Originally Posted by turbulent

Hi, Kevin

I'm using Sigil 0.8.2 on Win7. I create a test plugin as below:

def run(bk):
    print 'This line should be displayed.'
    print variable_not_exist
    return 0

Running this plugin, the message is:

Status: failed

Traceback (most recent call last):
  File "C:\Program Files\Sigil\plugin_launchers\\python\launcher.py", line 135, in launch
    self.exitcode = target_script.run(container)
  File "C:\Users\xj\AppData\Local\sigil-ebook\sigil\plugins\test\plugin.py", line 7, in run
    print variable_not_exist
NameError: global name 'variable_not_exist' is not defined
Error: global name 'variable_not_exist' is not defined

"variable_not_exist" is undefined to trigger the error. I expect the message "This line should be displayed." to show up. But it didn't.

[turbulent]

Hi, Kevin

I think I understand it. Thanks for your detailed explanation.