idmtools.entities.command_task module

class idmtools.entities.command_task.CommandTask(command: Union[str, idmtools.entities.command_line.CommandLine] = <property object at 0x7f7634030b30>, platform_requirements: Set[idmtools.entities.platform_requirements.PlatformRequirements] = <factory>, _ITask__pre_creation_hooks: List[Callable[[Union[ForwardRef('Simulation'), ForwardRef('IWorkflowItem')], ForwardRef('IPlatform')], NoReturn]] = <factory>, _ITask__post_creation_hooks: List[Callable[[Union[ForwardRef('Simulation'), ForwardRef('IWorkflowItem')], ForwardRef('IPlatform')], NoReturn]] = <factory>, common_assets: idmtools.assets.asset_collection.AssetCollection = <factory>, transient_assets: idmtools.assets.asset_collection.AssetCollection = <factory>, gather_common_asset_hooks: List[Callable[[idmtools.entities.itask.ITask], idmtools.assets.asset_collection.AssetCollection]] = <factory>, gather_transient_asset_hooks: List[Callable[[idmtools.entities.itask.ITask], idmtools.assets.asset_collection.AssetCollection]] = <factory>)

Bases: idmtools.entities.itask.ITask

gather_common_asset_hooks: List[Callable[[idmtools.entities.itask.ITask], idmtools.assets.asset_collection.AssetCollection]]

Hooks to gather common assets

gather_transient_asset_hooks: List[Callable[[idmtools.entities.itask.ITask], idmtools.assets.asset_collection.AssetCollection]]

Defines an extensible simple task that implements functionality through optional supplied use hooks

gather_common_assets() → idmtools.assets.asset_collection.AssetCollection

Gather common(experiment-level) assets for task

Returns

AssetCollection containing common assets

gather_transient_assets() → idmtools.assets.asset_collection.AssetCollection

Gather transient(experiment-level) assets for task

Returns

AssetCollection containing transient assets

reload_from_simulation(simulation: idmtools.entities.simulation.Simulation)

Optional hook that is called when loading simulations from a platform

pre_creation(parent: Union[Simulation, IWorkflowItem], platform: IPlatform)

Optional Hook called at the time of creation of task. Can be used to setup simulation and experiment level hooks :param parent: Parent of Item :param platform: Platform executing the task. Useful for querying platform before execution

Returns:

class idmtools.entities.command_task.CommandTaskSpecification

Bases: idmtools.registry.task_specification.TaskSpecification

get(configuration: dict) → idmtools.entities.command_task.CommandTask

Get instance of CommandTask with configuration

Parameters

configuration – configuration for CommandTask

Returns

CommandTask with configuration

get_description() → str

Get description of plugin

Returns

Plugin description

get_example_urls() → List[str]

Get example urls related to CommandTask

Returns

List of urls that have examples related to CommandTask

get_type() → Type[idmtools.entities.command_task.CommandTask]

Get task type provided by plugin

Returns

CommandTask

get_version() → str

Returns the version of the plugin

Returns: