Package Pyblosxom :: Package cache :: Module entryshelve :: Class BlosxomCache
[show private | hide private]
[frames | no frames]

Class BlosxomCache

BlosxomCacheBase --+
                   |
                  BlosxomCache


Method Summary
  __init__(self, req, config)
Constructor - setup and load up the cache
  close(self)
Close your cache if necessary.
  getEntry(self)
Get data from shelve
boolean isCached(self)
Returns 0 or 1 based on whether there is cached data, returns 0 is cache data is stale
  keys(self)
List out a list of keys for the cache, to be overridden by a subclass if a full dict interface is required.
  load(self, entryid)
Try to load up the cache with entryid (a unique key for the entry)
  rmEntry(self)
Remove cache entry: This is not used by pyblosxom, but used by utilities
  saveEntry(self, entrydata)
Save data in the pickled file
    Inherited from BlosxomCacheBase
  __delitem__(self, key)
  __getitem__(self, key)
Convenience function to make this class look like a dict
  __setitem__(self, key, value)
Synonymous to saveEntry
  get(self, key, default)
  has_key(self, key)

Method Details

__init__(self, req, config)
(Constructor)

Constructor - setup and load up the cache
Parameters:
req - the request object
           (type=Request)
config - String containing config on where to store the cache
           (type=string)
Overrides:
Pyblosxom.cache.base.BlosxomCacheBase.__init__ (inherited documentation)

close(self)

Close your cache if necessary.
Overrides:
Pyblosxom.cache.base.BlosxomCacheBase.close (inherited documentation)

getEntry(self)

Get data from shelve
Overrides:
Pyblosxom.cache.base.BlosxomCacheBase.getEntry

isCached(self)

Returns 0 or 1 based on whether there is cached data, returns 0 is cache data is stale
Returns:
0 or 1 based on cache
           (type=boolean)
Overrides:
Pyblosxom.cache.base.BlosxomCacheBase.isCached (inherited documentation)

keys(self)

List out a list of keys for the cache, to be overridden by a subclass if a full dict interface is required.
Overrides:
Pyblosxom.cache.base.BlosxomCacheBase.keys (inherited documentation)

load(self, entryid)

Try to load up the cache with entryid (a unique key for the entry)
Parameters:
entryid - The key identifier for your cache
           (type=string)
Overrides:
Pyblosxom.cache.base.BlosxomCacheBase.load (inherited documentation)

rmEntry(self)

Remove cache entry: This is not used by pyblosxom, but used by utilities
Overrides:
Pyblosxom.cache.base.BlosxomCacheBase.rmEntry (inherited documentation)

saveEntry(self, entrydata)

Save data in the pickled file
Overrides:
Pyblosxom.cache.base.BlosxomCacheBase.saveEntry

Generated by Epydoc 2.1 on Tue Feb 7 21:43:58 2006 http://epydoc.sf.net