exopy.tasks.configs.base_configs module¶

Standard task configurers.

exopy.tasks.configs.base_configs.task_manager()[source]¶: Delayed import of TaskManagerPlugin.

class exopy.tasks.configs.base_configs.BaseTaskConfig(**kwargs)[source]¶

Bases: atom.atom.Atom

Base class for task configurer.

future_parent¶: Future parent in the task hierarchy used to enforce name uniqueness.

manager¶: Task manager, necessary to retrieve task implementations.

task_name¶: Name of the task to create.

task_class¶: Class of the task to create.

ready¶: Bool indicating if the build can be done.

name_valid¶: Bool indicating if the name is valid.

check_parameters()[source]¶: The only parameter required is a unique task name.

build_task()[source]¶

This method use the user parameters to build the task object

Returns: task – Task object built using the user parameters. Ready to be inserted in a task hierarchy.
Return type: BaseTask

class exopy.tasks.configs.base_configs.PyTaskConfig(**kwargs)[source]¶

Bases: exopy.tasks.configs.base_configs.BaseTaskConfig

Standard configurer for python tasks.

This configurer is suitable for most python task whose initialisation simply requires a name.

task_doc¶

A value of type str.

Under Python 2 this is a byte string and behaves as Bytes with respect to promotion, under Python 3 it is a unicode string and behaves as Unicode with respect to promotion.

The use of this member is discouraged in Python 2/3 compatible codebase as Bytes and Unicode provide a more homogeneous behavior.

build_task()[source]¶

This method use the user parameters to build the task object

Returns: task – Task object built using the user parameters. Ready to be inserted in a task hierarchy.
Return type: BaseTask

class exopy.tasks.configs.base_configs.TemplateTaskConfig(**kwargs)[source]¶

Bases: exopy.tasks.configs.base_configs.BaseTaskConfig

Configurer for template task.

This configurer use the data stored about a task hierarchy to rebuild it from scratch.

template_path¶: Path to the file storing the hierarchy.

template_doc¶: Description of the template.

build_task()[source]¶: Build the task stored in the selected template.