pep8'd sugar3.dispatch

This commit is contained in:
William Orr 2013-05-17 22:11:41 -04:00 committed by Daniel Narvaez
parent 220c9b68ef
commit 51f07bba81
3 changed files with 69 additions and 55 deletions

View File

@ -1,6 +1,7 @@
"""Multi-consumer multi-producer dispatching mechanism """Multi-consumer multi-producer dispatching mechanism
Originally based on pydispatch (BSD) http://pypi.python.org/pypi/PyDispatcher/2.0.1 Originally based on pydispatch (BSD)
http://pypi.python.org/pypi/PyDispatcher/2.0.1
See license.txt for original license. See license.txt for original license.
Heavily modified for Django's purposes. Heavily modified for Django's purposes.

View File

@ -8,11 +8,13 @@ from sugar3.dispatch import saferef
WEAKREF_TYPES = (weakref.ReferenceType, saferef.BoundMethodWeakref) WEAKREF_TYPES = (weakref.ReferenceType, saferef.BoundMethodWeakref)
def _make_id(target): def _make_id(target):
if hasattr(target, 'im_func'): if hasattr(target, 'im_func'):
return (id(target.im_self), id(target.im_func)) return (id(target.im_self), id(target.im_func))
return id(target) return id(target)
class Signal(object): class Signal(object):
"""Base class for all signals """Base class for all signals
@ -21,7 +23,8 @@ class Signal(object):
""" """
def __init__(self, providing_args=None): def __init__(self, providing_args=None):
"""providing_args -- A list of the arguments this signal can pass along in """providing_args -- A list of the arguments
this signal can pass along in
a send() call. a send() call.
""" """
self.receivers = [] self.receivers = []
@ -67,7 +70,8 @@ class Signal(object):
lookup_key = (_make_id(receiver), _make_id(sender)) lookup_key = (_make_id(receiver), _make_id(sender))
if weak: if weak:
receiver = saferef.safeRef(receiver, onDelete=self._remove_receiver) receiver = saferef.safeRef(
receiver, onDelete=self._remove_receiver)
for r_key, _ in self.receivers: for r_key, _ in self.receivers:
if r_key == lookup_key: if r_key == lookup_key:
@ -75,7 +79,8 @@ class Signal(object):
else: else:
self.receivers.append((lookup_key, receiver)) self.receivers.append((lookup_key, receiver))
def disconnect(self, receiver=None, sender=None, weak=True, dispatch_uid=None): def disconnect(self, receiver=None, sender=None, weak=True,
dispatch_uid=None):
"""Disconnect receiver from sender for signal """Disconnect receiver from sender for signal
receiver -- the registered receiver to disconnect. May be none if receiver -- the registered receiver to disconnect. May be none if
@ -140,7 +145,8 @@ class Signal(object):
Return a list of tuple pairs [(receiver, response), ... ], Return a list of tuple pairs [(receiver, response), ... ],
may raise DispatcherKeyError may raise DispatcherKeyError
if any receiver raises an error (specifically any subclass of Exception), if any receiver raises an error (specifically any subclass of
Exception),
the error instance is returned as the result for that receiver. the error instance is returned as the result for that receiver.
""" """

View File

@ -5,7 +5,9 @@ Provides a way to safely weakref any function, including bound methods (which
aren't handled by the core weakref module). aren't handled by the core weakref module).
""" """
import weakref, traceback import weakref
import traceback
def safeRef(target, onDelete=None): def safeRef(target, onDelete=None):
"""Return a *safe* weak reference to a callable target """Return a *safe* weak reference to a callable target
@ -22,7 +24,9 @@ def safeRef(target, onDelete = None):
if target.im_self is not None: if target.im_self is not None:
# Turn a bound method into a BoundMethodWeakref instance. # Turn a bound method into a BoundMethodWeakref instance.
# Keep track of these instances for lookup by disconnect(). # Keep track of these instances for lookup by disconnect().
assert hasattr(target, 'im_func'), """safeRef target %r has im_self, but no im_func, don't know how to create reference"""%( target,) assert hasattr(target, 'im_func'), \
"safeRef target %r has im_self, but no im_func, " \
"don't know how to create reference" % (target,)
reference = get_bound_method_weakref( reference = get_bound_method_weakref(
target=target, target=target,
onDelete=onDelete onDelete=onDelete
@ -33,6 +37,7 @@ def safeRef(target, onDelete = None):
else: else:
return weakref.ref(target) return weakref.ref(target)
class BoundMethodWeakref(object): class BoundMethodWeakref(object):
"""'Safe' and reusable weak references to instance methods """'Safe' and reusable weak references to instance methods
@ -122,9 +127,8 @@ class BoundMethodWeakref(object):
try: try:
traceback.print_exc() traceback.print_exc()
except AttributeError: except AttributeError:
print '''Exception during saferef %s cleanup function %s: %s'''%( print "Exception during saferef %s cleanup "
self, function, e "function %s: %s" % (self, function, e)
)
self.deletionMethods = [onDelete] self.deletionMethods = [onDelete]
self.key = self.calculateKey(target) self.key = self.calculateKey(target)
self.weakSelf = weakref.ref(target.im_self, remove) self.weakSelf = weakref.ref(target.im_self, remove)
@ -179,14 +183,15 @@ class BoundMethodWeakref(object):
return function.__get__(target) return function.__get__(target)
return None return None
class BoundNonDescriptorMethodWeakref(BoundMethodWeakref): class BoundNonDescriptorMethodWeakref(BoundMethodWeakref):
"""A specialized BoundMethodWeakref, for platforms where instance methods """A specialized BoundMethodWeakref, for platforms where instance methods
are not descriptors. are not descriptors.
It assumes that the function name and the target attribute name are the It assumes that the function name and the target attribute name are the
same, instead of assuming that the function is a descriptor. This approach same, instead of assuming that the function is a descriptor. This approach
is equally fast, but not 100% reliable because functions can be stored on an is equally fast, but not 100% reliable because functions can be stored on
attribute named differenty than the function's name such as in: an attribute named differenty than the function's name such as in:
class A: pass class A: pass
def foo(self): return "foo" def foo(self): return "foo"
@ -239,12 +244,14 @@ class BoundNonDescriptorMethodWeakref(BoundMethodWeakref):
return getattr(target, function.__name__) return getattr(target, function.__name__)
return None return None
def get_bound_method_weakref(target, onDelete): def get_bound_method_weakref(target, onDelete):
"""Instantiates the appropiate BoundMethodWeakRef, depending on the details of """Instantiates the appropiate BoundMethodWeakRef, depending on the
the underlying class method implementation""" details of the underlying class method implementation"""
if hasattr(target, '__get__'): if hasattr(target, '__get__'):
# target method is a descriptor, so the default implementation works: # target method is a descriptor, so the default implementation works:
return BoundMethodWeakref(target=target, onDelete=onDelete) return BoundMethodWeakref(target=target, onDelete=onDelete)
else: else:
# no luck, use the alternative implementation: # no luck, use the alternative implementation:
return BoundNonDescriptorMethodWeakref(target=target, onDelete=onDelete) return BoundNonDescriptorMethodWeakref(target=target,
onDelete=onDelete)