Editor callback function does not get cleared if used as bound method in a class

[Ekopalypse]

Consider the following script

from Npp import editor, notepad, SCINTILLANOTIFICATION, NOTIFICATION

class X:

    def __init__(self):
        notepad.callback(self.on_buffer_activated, [NOTIFICATION.BUFFERACTIVATED])
        editor.callbackSync(self.on_double_click, [SCINTILLANOTIFICATION.DOUBLECLICK])
        editor.callbackSync(self.on_focus_out, [SCINTILLANOTIFICATION.FOCUSOUT])


    @staticmethod
    def on_double_click(args):
        # this one does get cleared
        print('on_double_click')


    def on_focus_out(self, args):
        # this doesn't get cleared :-(
        # differece to on_double_click is that this is a bound method,
        # whereas on_double_click is, basically, a function.
        print('on_focus_out')


    def on_buffer_activated(self, args):
        # Now the cofusing part, this is also a bound method but does get cleared
        # Difference: this is a notepad object callback.
        print('on_buffer_activated')


    def clear(self):
        notepad.clearCallbacks(self.on_buffer_activated, [NOTIFICATION.BUFFERACTIVATED])
        editor.clearCallbacks(self.on_double_click, [SCINTILLANOTIFICATION.DOUBLECLICK])
        editor.clearCallbacks(self.on_focus_out, [SCINTILLANOTIFICATION.FOCUSOUT])
       
try:
    active_instance
    active_instance.clear()
    del(active_instance)
except NameError:
    active_instance = X()

On first run it will register three callbacks. On next run, two out of the three callbacks get cleared but the on_focus_out callback remains active.

Happens with PythonScript version 3.0.3 as well as with 1.5.4

[chcg]

One difference is in:

PythonScript/PythonScript/src/NotepadPython.cpp

Lines 83 to 86 in 4c34bfb

	.def("clearCallbacks", &NotepadPlusWrapper::clearAllCallbacks, "Clears all callbacks")
	.def("clearCallbacks", &NotepadPlusWrapper::clearCallbackFunction, boost::python::args("callable"), "Clears all callbacks for the given function")
	.def("clearCallbacks", &NotepadPlusWrapper::clearCallbackEvents, boost::python::args("notificationList"), "Clears all callbacks for the given list of events - list of NOTIFICATION constants")
	.def("clearCallbacks", &NotepadPlusWrapper::clearCallback, boost::python::args("callable", "notificationList"), "Clears the callback for the given callback function for the list of events (NOTIFICATION constants)")

vs:

PythonScript/PythonScript/src/ScintillaPython.cpp

Lines 43 to 46 in 99243a6

	.def("clearCallbacks", &ScintillaWrapper::clearAllCallbacks, "Clears all callbacks")
	.def("clearCallbacks", &ScintillaWrapper::clearCallbackFunction, "Clears all callbacks for a given function")
	.def("clearCallbacks", &ScintillaWrapper::clearCallbackEvents, "Clears all callbacks for the given list of events")
	.def("clearCallbacks", &ScintillaWrapper::clearCallback, "Clears the callback for the given callback function for the list of events")

-> the parameters as boost::python::args() are missing, which were added for notepad with:

SHA-1: aa8c0b57392fb7b51c7abf9c9bde3319c63308da

* Arguments help for Notepad object

It could be tested with just the object or just the list if the call to clearCallbacks also fails in that case and what happens if just the problematic callback is registered.

[chcg]

Issue could be reproduced. Also:

editor.clearCallbacks(self.on_focus_out)

isn't working because the stored callback object from adding it is not matching the one from clearing.

editor.clearCallbacks([SCINTILLANOTIFICATION.FOCUSOUT])
is working as expected.

[Ekopalypse]

Sorry for late response - I was away for two days.

isn't working because the stored callback object from adding it is not matching the one from clearing.

Hmm, that sound strange. The id of the function should not have changed, neither its memory location.
Do you see how this object is different?

[Ekopalypse]

Can confirm that PS 3.0.4 solves the reported issue.

[chcg]

Fix also added to stable branch with Revision: e4b9960

[chcg]

Fixed with https://github.com/bruderstein/PythonScript/releases/tag/v2.0.0