class documentation

class FilesystemMetadataStore(MetadataStore): (source)

View In Hierarchy

Undocumented

Method __init__ Undocumented
Method commit If the backing store requires a commit, do it.
Method getmtime Read the mtime of a metadata entry..
Method list​_all Undocumented
Method read Read the contents of a metadata entry.
Method remove Delete a metadata entry
Method write Write a metadata entry.
Instance Variable cache​_dir​_prefix Undocumented
def __init__(self, cache_dir_prefix): (source)

Undocumented

Parameters
cache​_dir​_prefix:strUndocumented
def commit(self): (source)

If the backing store requires a commit, do it.

But N.B. that this is not guaranteed to do anything, and there is no guarantee that changes are not made until it is called.

def getmtime(self, name): (source)

Read the mtime of a metadata entry..

Raises FileNotFound if the entry does not exist.

Parameters
name:strUndocumented
Returns
floatUndocumented
def list_all(self): (source)

Undocumented

Returns
Iterable[str]Undocumented
def read(self, name): (source)

Read the contents of a metadata entry.

Raises FileNotFound if the entry does not exist.

Parameters
name:strUndocumented
Returns
strUndocumented
def remove(self, name): (source)
Delete a metadata entry
Parameters
name:strUndocumented
def write(self, name, data, mtime=None): (source)

Write a metadata entry.

If mtime is specified, set it as the mtime of the entry. Otherwise, the current time is used.

Returns True if the entry is successfully written, False otherwise.

Parameters
name:strUndocumented
data:strUndocumented
mtime:Optional[float]Undocumented
Returns
boolUndocumented
cache_dir_prefix = (source)

Undocumented