keggtools.storage

Storage of KEGG data. Caching downloaded files from API to local file system.

Classes

Storage

Storage handler class.

Module Contents

class keggtools.storage.Storage(cachedir=None)

Storage handler class.

Parameters:

cachedir (str | None)

build_cache_path(filename)

Build absolute filename for caching directory.

Parameters:

filename (str) – Name of file (is used as suffix to cache directory).

Returns:

Full filename with is inside cache folder.

Return type:

str

cachedir = None

check_cache_dir()

Checks if cache dir exist. Raises “NotADirectoryError” of caching folder not found.

Raises:

NotADirectoryError – Error if cache folder does not exist.

Return type:

None

exist(filename)

Check if filename exist in caching dir.

Parameters:

filename (str) – Filename to check.

Returns:

Returns True if file with given name exist in cachedir.

Return type:

bool

load(filename)

Load string from file.

Parameters:

filename (str) – Filename of file to load from cache folder.

Returns:

File content string.

Return type:

str

load_dump(filename)

Load binary dump from file.

Parameters:

filename (str) – Filename of file to load from cache folder.

Returns:

Object from file.

Return type:

Any

save(filename, data)

Save string as file in local storage. Returns absolute filename of save file.

Parameters:

• filename (str) – Filename to storage file at.

• data (str) – String data to save to cache file.

Returns:

Full filename to cached file.

Return type:

str

save_dump(filename, data)

Save binary dump as file in local storage. Returns absolute filename of save file.

Parameters:

• filename (str) – Filename to storage file at.

• data (Any) – Data to store to cache file. Can be any object.

Returns:

Full filename to cached file.

Return type:

str