Base Class for Caching stories in pyblosxom.
A cache is a disposable piece of data that gets updated when an entry
is in a fresh state.
Drivers are to subclass this object, overriding methods defined in
this class. If there is an error in creating cache data, be as quite as
possible, document how a user could check whether his cache works.
Driver should expect empty caches and should attempt to create them
from scratch.
|
|
__delitem__(self,
key)
Convenience function to make this look more like a dict. |
source code
|
|
|
|
__getitem__(self,
key)
Convenience function to make this class look like a dict. |
source code
|
|
|
|
|
|
|
|
|
|
close(self)
Override this to close your cache if necessary. |
source code
|
|
|
|
get(self,
key,
default=None)
Convenience function to make this look more like a dict. |
source code
|
|
|
|
getEntry(self)
Gets the data from the cache, returns a dict or an empty dict. |
source code
|
|
|
|
has_key(self,
key)
Convenience function to make this look more like a dict. |
source code
|
|
|
boolean
|
isCached(self)
Returns 0 or 1 based on whether there is cached data, returns 0 is
cache data is stale |
source code
|
|
|
|
keys(self)
List out a list of keys for the cache, to be overridden by a
subclass if a full dict interface is required. |
source code
|
|
|
|
load(self,
entryid)
Try to load up the cache with entryid (a unique key for the
entry) |
source code
|
|
|
|
rmEntry(self)
Remove cache entry: This is not used by pyblosxom, but used by
utilities. |
source code
|
|
|
|
|