plugin disable function does not get called when exaile exits

[Oben Sonne]

Exaile version: 0.2.99.3+ (bzr revision 2326)

Distro: Ubuntu 9.04 (Jaunty)

Exaile does not call a plugin's disable method on exit. In contrast, it gets called when a plugin is disabled manually in the preferences dialog.

Steps to reproduce:
1. Enable the "Hello World" plugin -> it says hello to standard out
2. Disable the plugin -> it says good bye
3. Enable it again and close Exaile -> the good bye is missing

This functionality is important, for instance to clean up network connections.

[Adam Olsen (arolsen)]

Fixed in r2327

[Oben Sonne (obensonne)]

Works now. That was fast :) Thanks

[Adam Olsen (arolsen)]

Actually, disable just for when the plugin is disabled.

In r2328, I've added a call to "teardown" for plugins. If your plugin defines a "teardown" function, it will be called when Exaile exits (but only if the plugin is currently enabled).

[Adam Olsen (arolsen)]

Oh, btw, the signature for this function is the same as enable, and disable

def teardown(exaile):
    # teardown code here

[reacocard (reacocard)]

Some further clarification on what Adam just said:

Most plugins's disable() calls contain things like removing an element from the GUI, which is a pointless action to take at shutdown time. Therefore, we dont call disable at shutdown, avoiding potential slowness and bugs. There has been for a long time a quit_application event that could be connected to for teardown purposes, and in r2383, Adam moved the same basic function directly into the plugin api with teardown(). However for the reasons outlined above against calling disable(), teardown() should do the bare minimum needed to shut down the plugin cleanly.

tl:dr version: calling disable() for everything is inefficient. use teardown() for things that absolutely must be run at shutdown, and disable() for everything else.

[Oben Sonne (obensonne)]

All right. This way I'm happy too.