visioncpp.cache

VisionCpp caching mechanism.

Provides a mechanism to cache compiled binaries to amortize compiler overheads.

visioncpp.cache.emplace(uid, path)

Move a binary into cache.

Arguments:

uid (str): UID. path (str): Path to file.

Returns:

str: Path to cached item.

visioncpp.cache.empty()

Empty the cache.

Moves the cache directory to the platform-specific Trash.

visioncpp.cache.get_uid(code)

Compute an ID for a piece of code.

Arguments:

code (str): The code to generate the uid for.

Returns:

str: UID.

visioncpp.cache.init(path=None)

Initialize cache.

This function is automatically called before any caching operation which would require it, however users may still call this to set an alternate cache location.

Arguments:

path (str, optional): Path to new cache location.

Returns:

str: Path to cache directory.

visioncpp.cache.is_cached(uid)

Returns whether there is a cache entry for the given ID.

Arguments:

uid (str): UID.

Returns:

bool: True if cached.

visioncpp.cache.load(uid)

Returns path to cached item.

Arguments:

uid (str): UID.

Returns:

str: Path to cached item.