Como se conectar a um sinal de gobject no python, sem manter uma referência ao conexão?
Pergunta
O problema é basicamente isso, nas ligações Gobject e GTK de Python. Suponha que tenhamos uma classe que se liga a um sinal quando construído:
class ClipboardMonitor (object):
def __init__(self):
clip = gtk.clipboard_get(gtk.gdk.SELECTION_CLIPBOARD)
clip.connect("owner-change", self._clipboard_changed)
O problema é agora que, Nenhuma instância do clipboardmonitor jamais morrerá. A área de transferência GTK é um objeto em todo self._clipboard_changed
.
Estou debatendo como contornar isso usando referências fracas (módulo fracas), mas ainda tenho que inventar um plano. Qualquer pessoa tem uma idéia de como passar um retorno de chamada para o registro do sinal e se comportar como uma referência fraca (se o retorno de chamada do sinal for chamado quando a instância do CLIPboardMonitor estiver fora do escopo, deve ser um não-operatório).
Adição: Formado independentemente do Gobject ou GTK+:
Como você fornece um método de retorno de chamada para um objeto opaco, com semântica fraca? Se o objeto de conexão sair do escopo, ele deve ser excluído e o retorno de chamada deve atuar como um não-operatório; O ConnectEe não deve manter uma referência ao conector.
Para esclarecer: eu quero explicitamente evitar ter que chamar um método "destruidor/finalizador"
Solução
A maneira padrão é desconectar o sinal. No entanto, isso precisa ter um método de destruidor em sua classe, chamado explicitamente pelo código que mantém seu objeto. Isso é necessário, porque, caso contrário, você obterá dependência circular.
class ClipboardMonitor(object):
[...]
def __init__(self):
self.clip = gtk.clipboard_get(gtk.gdk.SELECTION_CLIPBOARD)
self.signal_id = self.clip.connect("owner-change", self._clipboard_changed)
def close(self):
self.clip.disconnect(self.signal_id)
Como você apontou, você precisa de fracos se quiser evitar a destruição explicita. Eu escreveria uma fábrica de retorno de chamada fraca, como:
import weakref
class CallbackWrapper(object):
def __init__(self, sender, callback):
self.weak_obj = weakref.ref(callback.im_self)
self.weak_fun = weakref.ref(callback.im_func)
self.sender = sender
self.handle = None
def __call__(self, *things):
obj = self.weak_obj()
fun = self.weak_fun()
if obj is not None and fun is not None:
return fun(obj, *things)
elif self.handle is not None:
self.sender.disconnect(self.handle)
self.handle = None
self.sender = None
def weak_connect(sender, signal, callback):
wrapper = CallbackWrapper(sender, callback)
wrapper.handle = sender.connect(signal, wrapper)
return wrapper
(Este é uma prova de código conceitual, funciona para mim - você provavelmente deve adaptar esta peça às suas necessidades). Poucas notas:
- Estou armazenando objeto de retorno de chamada e função separatelly. Você não pode simplesmente criar um método fraco de um método vinculado, porque os métodos vinculados são objetos muito temporários. Na realidade
weakref.ref(obj.method)
Destruirá o objeto Método Ligado instantaneamente após criar um fraco. Não verifiquei se é necessário armazenar um fraco para a função também ... Acho que se seu código for estático, você provavelmente pode evitar isso. - O invólucro de objetos se removerá do remetente do sinal quando perceber que a fraca referência deixou de existir. Isso também é necessário para destruir a dependência circular entre o chamada de chamada e o objeto do remetente do sinal.
Outras dicas
(Esta resposta rastreia meu progresso)
Esta segunda versão também se desconectará; Eu tenho uma função de conveniência para Gobjects, mas realmente preciso desta classe para um caso mais geral-tanto para retornos de chamada do sinal D-BUS quanto para retornos de chamada GOBJET.
Enfim, o que se pode chamar de WeakCallback
Estilo de implementação? É um encapsulamento muito limpo do fraco retorno de chamada, mas com a especialização do Gobject/DBUs inacreditável. Beats escrevendo duas subclasses para esses dois casos.
import weakref
class WeakCallback (object):
"""A Weak Callback object that will keep a reference to
the connecting object with weakref semantics.
This allows to connect to gobject signals without it keeping
the connecting object alive forever.
Will use @gobject_token or @dbus_token if set as follows:
sender.disconnect(gobject_token)
dbus_token.remove()
"""
def __init__(self, obj, attr):
"""Create a new Weak Callback calling the method @obj.@attr"""
self.wref = weakref.ref(obj)
self.callback_attr = attr
self.gobject_token = None
self.dbus_token = None
def __call__(self, *args, **kwargs):
obj = self.wref()
if obj:
attr = getattr(obj, self.callback_attr)
attr(*args, **kwargs)
elif self.gobject_token:
sender = args[0]
sender.disconnect(self.gobject_token)
self.gobject_token = None
elif self.dbus_token:
self.dbus_token.remove()
self.dbus_token = None
def gobject_connect_weakly(sender, signal, connector, attr, *user_args):
"""Connect weakly to GObject @sender's @signal,
with a callback in @connector named @attr.
"""
wc = WeakCallback(connector, attr)
wc.gobject_token = sender.connect(signal, wc, *user_args)
Na verdade, ainda não tentei, mas:
class WeakCallback(object):
"""
Used to wrap bound methods without keeping a ref to the underlying object.
You can also pass in user_data and user_kwargs in the same way as with
rpartial. Note that refs will be kept to everything you pass in other than
the callback, which will have a weakref kept to it.
"""
def __init__(self, callback, *user_data, **user_kwargs):
self.im_self = weakref.proxy(callback.im_self, self._invalidated)
self.im_func = weakref.proxy(callback.im_func)
self.user_data = user_data
self.user_kwargs = user_kwargs
def __call__(self, *args, **kwargs):
kwargs.update(self.user_kwargs)
args += self.user_data
self.im_func(self.im_self, *args, **kwargs)
def _invalidated(self, im_self):
"""Called by the weakref.proxy object."""
cb = getattr(self, 'cancel_callback', None)
if cb is not None:
cb()
def add_cancel_function(self, cancel_callback):
"""
A ref will be kept to cancel_callback. It will be called back without
any args when the underlying object dies.
You can wrap it in WeakCallback if you want, but that's a bit too
self-referrential for me to do by default. Also, that would stop you
being able to use a lambda as the cancel_callback.
"""
self.cancel_callback = cancel_callback
def weak_connect(sender, signal, callback):
"""
API-compatible with the function described in
http://stackoverflow.com/questions/1364923/. Mostly used as an example.
"""
cb = WeakCallback(callback)
handle = sender.connect(signal, cb)
cb.add_cancel_function(WeakCallback(sender.disconnect, handle))