t.p.h.HierarchicalBucketFilter : class documentation

Filter things into buckets that can be nested.

Class Variable	bucketFactory	Class of buckets to make. (type: `Bucket`)
Class Variable	sweepInterval	Seconds between sweeping out the bucket cache. (type: `int`)
Method	__init__	Undocumented
Method	getBucketFor	Find or create a `Bucket` corresponding to the provided parameters.
Method	getBucketKey	Construct a key based on the input parameters to choose a `Bucket`.
Method	sweep	Remove empty buckets.

bucketFactory =

Class of buckets to make. (type: Bucket)

sweepInterval =

Seconds between sweeping out the bucket cache. (type: int)

def __init__(self, parentFilter=None): (source)

Undocumented

def getBucketFor(self, *a, **kw): (source)

Find or create a Bucket corresponding to the provided parameters.

Any parameters are passed on to getBucketKey, from them it decides which bucket you get.

Returns (type: Bucket)

def getBucketKey(self, *a, **kw): (source)

Construct a key based on the input parameters to choose a Bucket.

The default implementation returns the same key for all arguments. Override this method to provide Bucket selection.

Returns Something to be used as a key in the bucket cache.

def sweep(self): (source)

Remove empty buckets.

API Documentation for Twisted, generated by pydoctor at 2012-09-01 11:44:56.