toil.jobStores.utils

Attributes

log

Exceptions

JobStoreUnavailableException

Raised when a particular type of job store is requested but can't be used.

Functions

generate_locator(job_store_type[, local_suggestion, ...])

Generate a random locator for a job store of the given type. Raises an

Module Contents

toil.jobStores.utils.log

exception toil.jobStores.utils.JobStoreUnavailableException

Bases: RuntimeError

Raised when a particular type of job store is requested but can’t be used.

toil.jobStores.utils.generate_locator(job_store_type, local_suggestion=None, decoration=None)

Generate a random locator for a job store of the given type. Raises an JobStoreUnavailableException if that job store cannot be used.

Parameters:

• job_store_type (str) – Registry name of the job store to use.

• local_suggestion (Optional[str]) – Path to a nonexistent local directory suitable for use as a file job store.

• decoration (Optional[str]) – Extra string to add to the job store locator, if convenient.

Return str:

Job store locator for a usable job store.

Return type:

str