Table Of Contents

Task¶

from inet.common.task

class Task(name='task', action='', print_run_start_separately=True, task_result_class=<class 'inet.common.task.TaskResult'>, **kwargs)[source]¶

Bases: object

Represents a self-contained operation that captures all necessary information in order to be run.

Initializes a new task object.

Parameters

name (string) – A human readable short description of the task, usually a noun.
action (string) – A human readable short description of the operation the task is carrying out, usually a verb.
print_run_start_separately (bool) – Specifies if the start and end of the task’s execution is printed separately wrapping around the execution.
task_result_class (string) – The Python class name of the produced task result object.

Methods

`rerun`	Runs the task again.
`run`	Runs the task.
`run_protected`	Runs the task in the protected environment wrapped by `run()`.

Attributes

rerun(**kwargs)[source]¶

Runs the task again.

Returns (TaskResult):: The task result.

run(dry_run=False, keyboard_interrupt_handler=None, handle_exception=True, **kwargs)[source]¶

Runs the task.

Parameters

dry_run (bool) – Specifies to skip the actual running of the task but do everything else.
keyboard_interrupt_handler (inet.common.KeyboardInterruptHandler or None) – Provides a class that will handle keyboard interrupts. This allows seamless exit from running multiple tasks.
handle_exception (bool) – Specifies if exceptions are caught and processed or passed to the caller.

Returns (TaskResult):: The task result.

run_protected(**kwargs)[source]¶

Runs the task in the protected environment wrapped by run(). This method is expected to be overridden by derived classes. The default implementation simply returns a task result with “DONE” result code.

Parameters: kwargs (dict) – Not used in this implementation.

Returns (TaskResult):: The task result.

MultipleTasks

TaskResult