Package SpecClient :: Module SpecEventsDispatcher :: Class BoundMethodWeakRef
[hide private]
[frames] | no frames]

Class BoundMethodWeakRef

source code

object --+
         |
        BoundMethodWeakRef

'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.

Attributes:
        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.

Instance Methods [hide private]
 
__init__(self, target, onDelete=None)
Return a weak-reference-like instance for a bound method
source code
 
__str__(self)
Give a friendly representation of the object
source code
 
__repr__(self)
Give a friendly representation of the object
source code
 
__nonzero__(self)
Whether we are still a valid reference
source code
 
__cmp__(self, other)
Compare with another reference
source code
 
__call__(self)
Return a strong reference to the bound method
source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __reduce__, __reduce_ex__, __setattr__, __sizeof__, __subclasshook__

Class Methods [hide private]
 
calculateKey(cls, target)
Calculate the reference key for this reference
source code
Static Methods [hide private]
a new object with type S, a subtype of T
__new__(cls, target, onDelete=None, *arguments, **named)
Create new instance or return current instance
source code
Class Variables [hide private]
  _allInstances = <WeakValueDictionary at 40365952>
Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__new__(cls, target, onDelete=None, *arguments, **named)
Static Method

source code 

Create new instance or return current instance

Basically this method of construction allows us to short-circuit creation of references to already- referenced instance methods. The key corresponding to the target is calculated, and if there is already an existing reference, that is returned, with its deletionMethods attribute updated. Otherwise the new instance is created and registered in the table of already-referenced methods.

Returns: a new object with type S, a subtype of T
Overrides: object.__new__

__init__(self, target, onDelete=None)
(Constructor)

source code 
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.

Overrides: object.__init__

calculateKey(cls, target)
Class Method

source code 

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__(self)
(Informal representation operator)

source code 

Give a friendly representation of the object

Overrides: object.__str__

__repr__(self)
(Representation operator)

source code 

Give a friendly representation of the object

Overrides: object.__repr__

__call__(self)
(Call operator)

source code 
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.