toil.batchSystems.options

Attributes

logger

Classes

OptionSetter

Protocol for the setOption function we get to let us set up CLI options for

Functions

set_batchsystem_options(batch_system, set_option)	Call set_option for all the options for the given named batch system, or
add_all_batchsystem_options(parser)

Module Contents

toil.batchSystems.options.logger

class toil.batchSystems.options.OptionSetter

Bases: Protocol

Protocol for the setOption function we get to let us set up CLI options for each batch system.

Actual functionality is defined in the Config class.

OptionType

__call__(option_name, parsing_function=None, check_function=None, default=None, env=None, old_names=None)

Parameters:

• option_name (str)

• parsing_function (collections.abc.Callable[[Any], OptionType] | None)

• check_function (collections.abc.Callable[[OptionType], None | bool] | None)

• default (OptionType | None)

• env (list[str] | None)

• old_names (list[str] | None)

Return type:

bool

toil.batchSystems.options.set_batchsystem_options(batch_system, set_option)

Call set_option for all the options for the given named batch system, or all batch systems if no name is provided.

Parameters:

• batch_system (str | None)

• set_option (OptionSetter)

Return type:

None

toil.batchSystems.options.add_all_batchsystem_options(parser)

Parameters:

parser (argparse.ArgumentParser | argparse._ArgumentGroup)

Return type:

None