sugar4.dispatch.saferef

“Safe weakrefs”, originally from pyDispatcher.

Provides a way to safely weakref any function, including bound methods (which aren’t handled by the core weakref module).

Classes

BoundMethodWeakref	'Safe' and reusable weak references to instance methods
BoundNonDescriptorMethodWeakref	A specialized BoundMethodWeakref, for platforms where instance methods

Functions

safeRef(target[, onDelete])	Return a safe weak reference to a callable target
get_bound_method_weakref(target, onDelete)	Instantiates the appropiate BoundMethodWeakRef, depending on the
im_self(func)
im_func(func)

Module Contents

sugar4.dispatch.saferef.safeRef(target, onDelete=None)

Return a safe weak reference to a callable target

target – the object to be weakly referenced, if it’s a

bound method reference, will create a BoundMethodWeakref, otherwise creates a simple weakref.

onDelete – if provided, will have a hard reference stored

to the callable to be called after the safe reference goes out of scope with the reference object, (either a weakref or a BoundMethodWeakref) as argument.

class sugar4.dispatch.saferef.BoundMethodWeakref(target, onDelete=None)

Bases: object

‘Safe’ and reusable weak references to instance methods

BoundMethodWeakref objects provide a mechanism for referencing a bound method without requiring that the method object itself (which is normally a transient object) is kept alive. Instead, the BoundMethodWeakref object keeps weak references to both the object and the function which together define the instance method.

key -- the identity key for the reference, calculated

by the class’s calculateKey method applied to the target instance method

deletionMethods -- sequence of callable objects taking

single argument, a reference to this object which will be called when either the target object or target function is garbage collected (i.e. when this object becomes invalid). These are specified as the onDelete parameters of safeRef calls.

weakSelf -- weak reference to the target object

weakFunc -- weak reference to the target function

Class Attributes:

_allInstances – class attribute pointing to all live

BoundMethodWeakref objects indexed by the class’s calculateKey(target) method applied to the target objects. This weak value dictionary is used to short-circuit creation so that multiple references to the same (object, function) pair produce the same BoundMethodWeakref instance.

Return a weak-reference-like instance for a bound method

target – the instance-method target for the weak

reference, must have im_self and im_func attributes and be reconstructable via:

target.im_func.__get__( target.im_self )

which is true of built-in instance methods.

onDelete – optional callback which will be called

when this weak reference ceases to be valid (i.e. either the object or the function is garbage collected). Should take a single argument, which will be passed a pointer to this object.

deletionMethods

key

weakSelf

weakFunc

selfName = ''

funcName = ''

classmethod calculateKey(target)

Calculate the reference key for this reference

Currently this is a two-tuple of the id()’s of the target object and the target function respectively.

__str__()

Give a friendly representation of the object

__repr__

__bool__()

Whether we are still a valid reference

__nonzero__()

Python2 alternative for __bool__

__cmp__(other)

Compare with another reference

__call__()

Return a strong reference to the bound method

If the target cannot be retrieved, then will return None, otherwise returns a bound instance method for our object and function.

Note

You may call this method any number of times, as it does not invalidate the reference.

class sugar4.dispatch.saferef.BoundNonDescriptorMethodWeakref(target, onDelete=None)

Bases: BoundMethodWeakref

A specialized BoundMethodWeakref, for platforms where instance methods are not descriptors.

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 is equally fast, but not 100% reliable because functions can be stored on an attribute named differenty than the function’s name such as in:

class A: pass def foo(self): return “foo” A.bar = foo

But this shouldn’t be a common use case. So, on platforms where methods aren’t descriptors (such as Jython) this implementation has the advantage of working in the most cases.

Return a weak-reference-like instance for a bound method

target – the instance-method target for the weak

reference, must have im_self and im_func attributes and be reconstructable via:

target.im_func.__get__( target.im_self )

which is true of built-in instance methods.

onDelete – optional callback which will be called

when this weak reference ceases to be valid (i.e. either the object or the function is garbage collected). Should take a single argument, which will be passed a pointer to this object.

__call__()

Return a strong reference to the bound method

If the target cannot be retrieved, then will return None, otherwise returns a bound instance method for our object and function.

Note

You may call this method any number of times, as it does not invalidate the reference.

sugar4.dispatch.saferef.get_bound_method_weakref(target, onDelete)

Instantiates the appropiate BoundMethodWeakRef, depending on the details of the underlying class method implementation

sugar4.dispatch.saferef.im_self(func)

sugar4.dispatch.saferef.im_func(func)