toil.batchSystems.registry

Attributes

logger

DEFAULT_BATCH_SYSTEM

Functions

add_batch_system_factory(key, class_factory)

Adds a batch system to the registry for workflow or plugin-supplied batch systems.

get_batch_systems()

Get the names of all the availsble batch systems.

get_batch_system(key)

Get a batch system class by name.

aws_batch_batch_system_factory()

gridengine_batch_system_factory()

lsf_batch_system_factory()

single_machine_batch_system_factory()

mesos_batch_system_factory()

slurm_batch_system_factory()

torque_batch_system_factory()

htcondor_batch_system_factory()

kubernetes_batch_system_factory()

__getattr__(name)

Implement a fallback attribute getter to handle deprecated constants.

addBatchSystemFactory(key, batchSystemFactory)

Deprecated method to add a batch system.

save_batch_system_plugin_state()

Return a snapshot of the plugin registry that can be restored to remove

restore_batch_system_plugin_state(snapshot)

Restore the batch system registry state to a snapshot from

Module Contents

toil.batchSystems.registry.logger
toil.batchSystems.registry.add_batch_system_factory(key, class_factory)[source]

Adds a batch system to the registry for workflow or plugin-supplied batch systems.

Parameters:
toil.batchSystems.registry.get_batch_systems()[source]

Get the names of all the availsble batch systems.

Return type:

Sequence[str]

toil.batchSystems.registry.get_batch_system(key)[source]

Get a batch system class by name.

Raises:

KeyError if the key is not the name of a batch system, and ImportError if the batch system’s class cannot be loaded.

Parameters:

key (str)

Return type:

Type[toil.batchSystems.abstractBatchSystem.AbstractBatchSystem]

toil.batchSystems.registry.DEFAULT_BATCH_SYSTEM = 'single_machine'
toil.batchSystems.registry.aws_batch_batch_system_factory()[source]
toil.batchSystems.registry.gridengine_batch_system_factory()[source]
toil.batchSystems.registry.lsf_batch_system_factory()[source]
toil.batchSystems.registry.single_machine_batch_system_factory()[source]
toil.batchSystems.registry.mesos_batch_system_factory()[source]
toil.batchSystems.registry.slurm_batch_system_factory()[source]
toil.batchSystems.registry.torque_batch_system_factory()[source]
toil.batchSystems.registry.htcondor_batch_system_factory()[source]
toil.batchSystems.registry.kubernetes_batch_system_factory()[source]
toil.batchSystems.registry.__getattr__(name)[source]

Implement a fallback attribute getter to handle deprecated constants.

See <https://stackoverflow.com/a/48242860>.

toil.batchSystems.registry.addBatchSystemFactory(key, batchSystemFactory)[source]

Deprecated method to add a batch system.

Parameters:
toil.batchSystems.registry.save_batch_system_plugin_state()[source]

Return a snapshot of the plugin registry that can be restored to remove added plugins. Useful for testing the plugin system in-process with other tests.

Return type:

Tuple[List[str], Dict[str, Callable[[], Type[toil.batchSystems.abstractBatchSystem.AbstractBatchSystem]]]]

toil.batchSystems.registry.restore_batch_system_plugin_state(snapshot)[source]

Restore the batch system registry state to a snapshot from save_batch_system_plugin_state().

Parameters:

snapshot (Tuple[List[str], Dict[str, Callable[[], Type[toil.batchSystems.abstractBatchSystem.AbstractBatchSystem]]]])