Exceptions API

Toil specific exceptions.

exception toil.job.JobException(message)[source]

General job exception.

Parameters:

message (str)

Return type:

None

__init__(message)[source]
Parameters:

message (str)

Return type:

None

exception toil.job.JobGraphDeadlockException(string)[source]

An exception raised in the event that a workflow contains an unresolvable dependency, such as a cycle. See toil.job.Job.checkJobGraphForDeadlocks().

Parameters:

string (str)

Return type:

None

__init__(string)[source]
Parameters:

string (str)

Return type:

None

exception toil.jobStores.abstractJobStore.ConcurrentFileModificationException(jobStoreFileID)[source]

Indicates that the file was attempted to be modified by multiple processes at once.

Parameters:

jobStoreFileID (FileID | str)

__init__(jobStoreFileID)[source]
Parameters:

jobStoreFileID (FileID | str) – the ID of the file that was modified by multiple workers or processes concurrently

exception toil.jobStores.abstractJobStore.JobStoreExistsException(locator, prefix)[source]

Indicates that the specified job store already exists.

Parameters:
__init__(locator, prefix)[source]
Parameters:

  • locator (str) – The location of the job store

  • locator

  • prefix (str)

exception toil.jobStores.abstractJobStore.NoSuchFileException(jobStoreFileID, customName=None, *extra)[source]

Indicates that the specified file does not exist.

Parameters:
__init__(jobStoreFileID, customName=None, *extra)[source]
Parameters:

  • jobStoreFileID (FileID | str) – the ID of the file that was mistakenly assumed to exist

  • customName (str | None) – optionally, an alternate name for the nonexistent file

  • extra (Any) – optional extra information to add to the error message

  • extra

exception toil.jobStores.abstractJobStore.NoSuchJobException(jobStoreID)[source]

Indicates that the specified job does not exist.

Parameters:

jobStoreID (FileID | str)

__init__(jobStoreID)[source]
Parameters:

  • jobStoreID (FileID | str) – the jobStoreID that was mistakenly assumed to exist

  • jobStoreID

exception toil.jobStores.abstractJobStore.NoSuchJobStoreException(locator, prefix)[source]

Indicates that the specified job store does not exist.

Parameters:
__init__(locator, prefix)[source]
Parameters:

  • locator (str) – The location of the job store

  • prefix (str) – The type of job store

  • locator

  • prefix