toil.utils.toilDebugFile

Debug tool for copying files contained in a toil jobStore.

Module Contents

Functions

fetchJobStoreFiles(jobStore, options)

Takes a list of file names as glob patterns, searches for these within a

printContentsOfJobStore(jobStorePath[, nameOfJob])

Fetch a list of all files contained in the jobStore directory input if

main()

Attributes

logger

toil.utils.toilDebugFile.logger
toil.utils.toilDebugFile.fetchJobStoreFiles(jobStore, options)[source]

Takes a list of file names as glob patterns, searches for these within a given directory, and attempts to take all of the files found and copy them into options.localFilePath.

Parameters:

  • jobStore (toil.jobStores.abstractJobStore.AbstractJobStore) – A fileJobStore object.

  • options.fetch – List of file glob patterns to search for in the jobStore and copy into options.localFilePath.

  • options.localFilePath – Local directory to copy files into.

  • options.jobStore – The path to the jobStore directory.

  • options (argparse.Namespace) –

Return type:

None

toil.utils.toilDebugFile.printContentsOfJobStore(jobStorePath, nameOfJob=None)[source]

Fetch a list of all files contained in the jobStore directory input if nameOfJob is not declared, otherwise it only prints out the names of files for that specific job for which it can find a match. Also creates a logFile containing this same record of job files in the working directory.

Parameters:

  • jobStorePath (str) – Directory path to recursively look for files.

  • nameOfJob (Optional[str]) – Default is None, which prints out all files in the jobStore.

Return type:

None

If specified, it will print all jobStore files that have been written to the jobStore by that job.

toil.utils.toilDebugFile.main()[source]
Return type:

None